Skip to content

Commit fa6b0b7

Browse files
committed
Update docs
1 parent 6a4a943 commit fa6b0b7

File tree

7 files changed

+55
-19
lines changed

7 files changed

+55
-19
lines changed

Diff for: docs/source/index.rst

+17-6
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,28 @@
22
Django MongoDB CLI
33
==================
44

5-
For testing Django MongoDB Backend with MongoDB's Django fork and third party libraries.
6-
75
.. note::
86

9-
This documentation is for the DBX Python team and developers of third
10-
party libraries that want to integrate their library with Django
11-
MongoDB Backend.
7+
This documentation is for the MongoDB DBX Python team and developers of third
8+
party libraries that support Django MongoDB Backend. End users of
9+
Django MongoDB Backend should refer to the
10+
`Django MongoDB Backend documentation`_.
11+
12+
This library provides the ``dm`` command line utility which can be used for:
13+
14+
- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party libraries <third-party-libraries>` with the ``dm repo`` command.
15+
- Testing `Django MongoDB Backend`_ projects with :ref:`third party libraries <third-party-libraries>` with the ``dm startproject`` command.
16+
17+
Table of Contents
18+
-----------------
1219

1320
.. toctree::
1421
:maxdepth: 2
1522

16-
installation
23+
installation/index
1724
third-party-library-support
1825
supported-libraries/index
26+
27+
.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
28+
.. _`Django fork`: https://github.com/mongodb-forks/django
29+
.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.0/

Diff for: docs/source/installation.rst

-10
This file was deleted.

Diff for: docs/source/installation/clone-repository.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Clone the repository
2+
====================
3+
4+
::
5+
6+
git clone https://github.com/mongodb-labs/django-mongodb-cli
7+
cd django-mongodb-cli

Diff for: docs/source/installation/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Installation
2+
============
3+
4+
5+
.. toctree::
6+
clone-repository
7+
venv
8+
usage

Diff for: docs/source/supported-libraries/index.rst

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
.. _third-party-libraries:
3+
14
Supported libraries
25
===================
36

Diff for: docs/source/third-party-library-support.rst

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
Third party library support
22
===========================
33

4+
.. note::
5+
6+
This is the criteria used to determine if a third party library is supported
7+
by Django MongoDB Backend. It is not a guarantee that the library will
8+
work without issues, just that these criteria have been met.
9+
410
Support for third party libraries is determined via the following:
511

6-
- Test suites
7-
- Project examples
8-
- Known limitations
12+
- :ref:`Test suites <test_suites>`
13+
- :ref:`Project examples <project_examples>`
14+
- :ref:`Known limitations <known_limitations>`
15+
16+
.. _test_suites:
917

1018
Test suites
1119
-----------
@@ -36,9 +44,13 @@ For each third party library that is supported, the following tasks are performe
3644

3745
- Replace static primary key references with dynamic references or static ``ObjectId`` references
3846

47+
.. _`project_examples`:
48+
3949
Project examples
4050
----------------
4151

52+
.. _`known_limitations`:
53+
4254
Known limitations
4355
-----------------
4456

Diff for: justfile

+5
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,8 @@ alias b := sphinx-build
9494
sphinx-serve:
9595
cd docs/_build && python -m http.server
9696
alias ss := sphinx-serve
97+
98+
[group('sphinx')]
99+
sphinx-clean:
100+
rm -rvf docs/_build
101+
alias sc := sphinx-clean

0 commit comments

Comments
 (0)