Merge pull request #22 from aclark4life/main

Update docs

Author: aclark4life

django_mongodb_cli/config.py

@@ -81,9 +81,7 @@
             "target": join("src", "django-rest-framework", "tests", "mongo_apps.py"),
         },
         "migrations_dir": {
-            "source": join(
-                "src", "rest_framework", "django-mongodb-project", "mongo_migrations"
-            ),
+            "source": join("src", "django-mongodb-project", "mongo_migrations"),
             "target": join("src", "django-rest-framework", "tests", "mongo_migrations"),
         },
         "test_command": "./runtests.py",

docs/source/_static/images/django-allauth.png

@@ -0,0 +1,19 @@
+Glossary
+========
+
+.. _django-mongodb-backend:
+
+Django MongoDB Backend
+----------------------
+
+- `Django MongoDB Backend`_ is a MongoDB database backend for Django.
+
+.. _mongodb-django-fork:
+
+MongoDB's Django Fork
+---------------------
+
+- `MongoDB's Django Fork`_ is a fork of Django used for testing and is **not required** to use Django with MongoDB.
+
+.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
+.. _`MongoDB's Django fork`: https://github.com/mongodb-forks/django

docs/source/_static/images/django-debug-toolbar.png

@@ -4,33 +4,33 @@ Django MongoDB CLI
 
 .. note::
 
-    This documentation is for the MongoDB Python Database Experience team and
-    developers of third party libraries interested in supporting
-    `Django MongoDB Backend`_.
+    This documentation is for MongoDB staff and developers of Django third
+    party libraries interested in supporting
+    :ref:`Django MongoDB Backend <django-mongodb-backend>`.
 
-    Users of `Django MongoDB Backend`_ should read the
-    `Django MongoDB Backend documentation`_.
+    End users of :ref:`Django MongoDB Backend <django-mongodb-backend>`
+    should read the `Django MongoDB Backend documentation`_.
 
 About
 -----
 
 This library provides the ``dm`` command which can be used for:
 
-- :ref:`Running third party library test suites <third-party-libraries>` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_.
-- Creating `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries <third-party-libraries>`.
+- :ref:`Running third party library test suites <third-party-libraries>` with
+  :ref:`Django MongoDB Backend <django-mongodb-backend>` and
+  :ref:`MongoDB's Django fork <mongodb-django-fork>`.
+- Creating `Django projects`_ with :ref:`Django MongoDB Backend <django-mongodb-backend>`
+  and :ref:`third party libraries <third-party-libraries>`.
 
 Table of Contents
 -----------------
 
 .. toctree::
-   :maxdepth: 3
-
    installation
    usage
    third-party-library-support/index
    supported-libraries/index
+   glossary
 
-.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend
-.. _`Django fork`: https://github.com/mongodb-forks/django
 .. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.1/
 .. _`Django projects`: https://docs.djangoproject.com/en/5.2/intro/tutorial01/#creating-a-project

docs/source/_static/images/django-filter.png

@@ -24,14 +24,20 @@ Install ``dm`` command
 
 ::
 
-    python -m pip install -e .
+    pip install -e .
 
 .. _additional-installation-steps:
 
 Additional installation steps
 -----------------------------
 
-Clone third-party library repositories and install dependencies with ``just``.
+.. note::
+
+    ``just install`` also installs the ``dm`` command as shown above
+    so in practice you can ``just install`` and skip the previous step.
+
+Install ``dm`` command, clone and install third-party library
+repositories and install dependencies with ``just install``.
 
 ::
 

docs/source/_static/images/django-rest-framework.png

@@ -14,7 +14,7 @@ Via ``dm repo test django-filter``
 |  63%                      | 1621       |     1023  | 584       |        1       |       13     |                    0       |   21             |
 +---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
 
-- `django-filter.txt <../_static/django-filter.txt>`_
+- `django-filter.txt <../_static/logs/django-filter.txt>`_
 
 Project examples
 ----------------

docs/source/_static/images/wagtail.png

@@ -14,7 +14,7 @@ Via ``dm repo test django-debug-toolbar``
 |  73%                      | 262        |     192   | 41        |        26      |       0      |                    1       |   0              |
 +---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
 
-- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_
+- `django-debug-toolbar.txt <../_static/logs/django-debug-toolbar.txt>`_
 
 Project examples
 ----------------

docs/source/_static/django-allauth.txt renamed to docs/source/_static/logs/django-allauth.txt

@@ -14,7 +14,7 @@ Via ``dm repo test django-filter``
 |  93%                      | 515        |      480  | 1         |       16       |       15     |                    3       |   0              |
 +---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
 
-- `django-filter.txt <../_static/django-filter.txt>`_
+- `django-filter.txt <../_static/logs/django-filter.txt>`_
 
 Project examples
 ----------------

docs/source/_static/django-debug-toolbar.txt renamed to docs/source/_static/logs/django-debug-toolbar.txt

@@ -14,7 +14,7 @@ Via ``dm repo test django-rest-framework``
 |  81%                      | 1558       |     1276  | 146       |        136     |       0      |                    0       |   4              |
 +---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
 
-- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_
+- `django-rest-framework.txt <../_static/logs/django-rest-framework.txt>`_
 
 Project examples
 ----------------

docs/source/_static/django-filter.txt renamed to docs/source/_static/logs/django-filter.txt

@@ -18,8 +18,8 @@ Via ``dm repo test wagtail``
 |  43%                      | 4897       |     2124  | 52        |        468     |       2252   |                    1       |   0              |
 +---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
 
-- `wagtail.txt <../_static/wagtail.txt>`_
-- `wagtail2.txt <../_static/wagtail2.txt>`_
+- `wagtail.txt <../_static/logs/wagtail.txt>`_
+- `wagtail2.txt <../_static/logs/wagtail2.txt>`_
 
 Project examples
 ----------------

docs/source/_static/django-rest-framework.txt renamed to docs/source/_static/logs/django-rest-framework.txt

@@ -4,6 +4,39 @@ Usage
 Run third-party library tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+django-filter
++++++++++++++
+
+::
+
+    dm repo test django-filter
+
+When completed successfully the output should look something like this:
+
+.. image:: _static/images/django-filter.png
+
+django-rest-framework
++++++++++++++++++++++
+
+::
+
+    dm repo test django-rest-framework
+
+When completed successfully the output should look something like this:
+
+.. image:: _static/images/django-rest-framework.png
+
+django-debug-toolbar
+++++++++++++++++++++
+
+::
+
+    dm repo test django-debug-toolbar
+
+When completed successfully the output should look something like this:
+
+.. image:: _static/images/django-debug-toolbar.png
+
 django-allauth
 ++++++++++++++
 
@@ -17,3 +50,18 @@ django-allauth
 ::
 
     dm repo test django-allauth
+
+When completed successfully the output should look something like this:
+
+.. image:: _static/images/django-allauth.png
+
+wagtail
++++++++
+
+::
+
+    dm repo test wagtail
+
+When completed successfully the output should look something like this:
+
+.. image:: _static/images/wagtail.png

docs/source/_static/wagtail.txt renamed to docs/source/_static/logs/wagtail.txt

@@ -30,6 +30,7 @@ git-clone:
     dm repo clone django-mongodb-extensions
     dm repo clone django-mongodb-project
     dm repo clone django-mongodb-templates
+    dm repo clone django-rest-framework
     dm repo clone mongo-python-driver
     dm repo clone python-xmlsec
 
@@ -97,10 +98,10 @@ sphinx-build:
 alias b := sphinx-build
 
 [group('sphinx')]
-sphinx-serve:
+sphinx-autobuild:
     # cd docs/_build && python -m http.server
     sphinx-autobuild docs/source docs/_build
-alias ss := sphinx-serve
+alias ab := sphinx-autobuild
 
 [group('sphinx')]
 sphinx-clean: