Skip to content

Commit 7b5cc95

Browse files
committed
Add glossary
1 parent 874e896 commit 7b5cc95

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

docs/source/glossary.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Glossary
2+
========
3+
4+
.. _django-mongodb-backend:
5+
6+
Django MongoDB Backend
7+
----------------------
8+
9+
- `Django MongoDB Backend`_ is a MongoDB database backend for Django.
10+
11+
.. _mongodb-django-fork:
12+
13+
MongoDB's Django Fork
14+
---------------------
15+
16+
- `MongoDB's Django Fork`_ is a fork of Django used for testing and is **not required** to use Django with MongoDB.
17+
18+
.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
19+
.. _`MongoDB's Django fork`: https://github.com/mongodb-forks/django

docs/source/index.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,32 @@ Django MongoDB CLI
55
.. note::
66

77
This documentation is for MongoDB staff and developers of Django third
8-
party libraries interested in supporting `Django MongoDB Backend`_.
8+
party libraries interested in supporting
9+
:ref:`Django MongoDB Backend <django-mongodb-backend>`.
910

10-
End users of `Django MongoDB Backend`_ should read the
11-
`Django MongoDB Backend documentation`_.
11+
End users of :ref:`Django MongoDB Backend <django-mongodb-backend>`
12+
should read the `Django MongoDB Backend documentation`_.
1213

1314
About
1415
-----
1516

1617
This library provides the ``dm`` command which can be used for:
1718

18-
- :ref:`Running third party library test suites <third-party-libraries>` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_.
19-
- Creating `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries <third-party-libraries>`.
19+
- :ref:`Running third party library test suites <third-party-libraries>` with
20+
:ref:`Django MongoDB Backend <django-mongodb-backend>` and
21+
:ref:`MongoDB's Django fork <mongodb-django-fork>`.
22+
- Creating `Django projects`_ with :ref:`Django MongoDB Backend <django-mongodb-backend>`
23+
and :ref:`third party libraries <third-party-libraries>`.
2024

2125
Table of Contents
2226
-----------------
2327

2428
.. toctree::
25-
:maxdepth: 3
26-
2729
installation
2830
usage
2931
third-party-library-support/index
3032
supported-libraries/index
33+
glossary
3134

32-
.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
33-
.. _`Django fork`: https://github.com/mongodb-forks/django
3435
.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.1/
3536
.. _`Django projects`: https://docs.djangoproject.com/en/5.2/intro/tutorial01/#creating-a-project

0 commit comments

Comments
 (0)