Merge pull request #23 from aclark4life/main

aclark4life · web-flow · commit 674e7cb90cae · 2025-04-23T16:03:01.000-04:00
Update docs
diff --git a/docs/source/_static/images/django-mongodb-backend.png b/docs/source/_static/images/django-mongodb-backend.png
diff --git a/docs/source/_static/images/django-mongodb-backend2.png b/docs/source/_static/images/django-mongodb-backend2.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -27,7 +27,7 @@ Table of Contents
 
 .. toctree::
    installation
-   usage
+   usage/index
    third-party-library-support/index
    supported-libraries/index
    glossary
diff --git a/docs/source/usage/django-mongodb-backend.rst b/docs/source/usage/django-mongodb-backend.rst
@@ -0,0 +1,28 @@
+Run django-mongodb-backend tests
+--------------------------------
+
+The :ref:`Django fork <mongodb-django-fork>` test runner also runs
+the django-mongodb-backend tests.
+
+List tests
+~~~~~~~~~~
+
+You can list them with the
+``dm repo test django -l`` command.
+
+::
+
+    dm repo test django -l
+
+.. image:: ../_static/images/django-mongodb-backend.png
+
+
+Run tests
+~~~~~~~~~
+
+Then you can run them by specifying the test module e.g. to run
+the tests for the ``backend`` module::
+
+    dm repo test django backend_
+
+.. image:: ../_static/images/django-mongodb-backend2.png
diff --git a/docs/source/usage/index.rst b/docs/source/usage/index.rst
@@ -0,0 +1,6 @@
+Usage
+=====
+
+.. toctree::
+   third-party
+   django-mongodb-backend
diff --git a/docs/source/usage/third-party.rst b/docs/source/usage/third-party.rst
@@ -1,44 +1,41 @@
-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
+.. 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
+.. 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
+.. image:: ../_static/images/django-debug-toolbar.png
 
 django-allauth
-++++++++++++++
+~~~~~~~~~~~~~~
 
 .. warning::
 
@@ -53,15 +50,15 @@ django-allauth
 
 When completed successfully the output should look something like this:
 
-.. image:: _static/images/django-allauth.png
+.. 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
+.. image:: ../_static/images/wagtail.png
