Update docs

docs/source/index.rst

@@ -16,19 +16,22 @@ About
 
 This library provides the ``dm`` command which can be used for:
 
-- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party library test suites <third-party-libraries>`.
-- Testing Django projects with `Django MongoDB Backend`_ and :ref:`third party libraries <third-party-libraries>`.
+- Testing
+
+
+  -  :ref:`Third party library test suites <third-party-libraries>` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_.
+  - `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries <third-party-libraries>`.
 
 Table of Contents
 -----------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    installation/index
    third-party-library-support/index
-   supported-libraries/index
 
 .. _`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/installation/index.rst

@@ -26,8 +26,8 @@ Install CLI
 
     python -m pip install -e .
 
-Install development dependencies
---------------------------------
+Clone third-party library repositories
+--------------------------------------
 
 ::
 

docs/source/third-party-library-support/index.rst

@@ -9,9 +9,16 @@ by Django MongoDB Backend. It is not a guarantee that the library will
 work without issues, just that these criteria have been met.
 
 Criteria
---------
+---------
 
 .. toctree::
     test-suites
     project-examples
     known-issues
+
+
+Suported Libraries
+------------------
+
+.. toctree::
+    supported-libraries/index

docs/source/third-party-library-support/supported-libraries/django-allauth.rst

@@ -0,0 +1,23 @@
+Django allauth
+==============
+
+.. _django-allauth-results:
+
+Test suite
+----------
+
+Via ``dm repo test django-filter``
+
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  **PERCENTAGE PASSED**    | **TOTAL**  |  **PASS** | **FAIL**  |  **SKIPPED**   |   **ERROR**  | **EXPECTED FAILURES**      |  **WARNING**     |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  63%                      | 1621       |     1023  | 584       |        1       |       13     |                    0       |   21             |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+
+- `django-filter.txt <../_static/django-filter.txt>`_
+
+Project examples
+----------------
+
+Known issues
+------------

docs/source/third-party-library-support/supported-libraries/django-debug-toolbar.rst

@@ -0,0 +1,23 @@
+Django debug toolbar
+====================
+
+.. _django-debug-toolbar-results:
+
+Test suite
+----------
+
+Via ``dm repo test django-debug-toolbar``
+
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  **PERCENTAGE PASSED**    | **TOTAL**  |  **PASS** | **FAIL**  |  **SKIPPED**   |   **ERROR**  | **EXPECTED FAILURES**      |  **WARNING**     |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  73%                      | 262        |     192   | 41        |        26      |       0      |                    1       |   0              |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+
+- `django-debug-toolbar.txt <../_static/django-debug-toolbar.txt>`_
+
+Project examples
+----------------
+
+Known issues
+------------

docs/source/third-party-library-support/supported-libraries/django-filter.rst

@@ -0,0 +1,23 @@
+Django filter
+=============
+
+Test suite
+----------
+
+.. _django-filter-results:
+
+Via ``dm repo test django-filter``
+
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  **PERCENTAGE PASSED**    | **TOTAL**  |  **PASS** | **FAIL**  |  **SKIPPED**   |   **ERROR**  | **EXPECTED FAILURES**      |  **WARNING**     |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  93%                      | 515        |      480  | 1         |       16       |       15     |                    3       |   0              |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+
+- `django-filter.txt <../_static/django-filter.txt>`_
+
+Project examples
+----------------
+
+Known issues
+------------

docs/source/third-party-library-support/supported-libraries/django-rest-framework.rst

@@ -0,0 +1,23 @@
+Django rest framework
+=====================
+
+.. _django-rest-framework-results:
+
+Test suite
+----------
+
+Via ``dm repo test django-rest-framework``
+
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  **PERCENTAGE PASSED**    | **TOTAL**  |  **PASS** | **FAIL**  |  **SKIPPED**   |   **ERROR**  | **EXPECTED FAILURES**      |  **WARNING**     |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  81%                      | 1558       |     1276  | 146       |        136     |       0      |                    0       |   4              |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+
+- `django-rest-framework.txt <../_static/django-rest-framework.txt>`_
+
+Project examples
+----------------
+
+Known issues
+------------

docs/source/supported-libraries/index.rst → docs/source/third-party-library-support/supported-libraries/index.rst

@@ -1,12 +1,6 @@
 
 .. _third-party-libraries:
 
-Supported libraries
-===================
-
-Overview
---------
-
 |
 
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
@@ -33,9 +27,6 @@ Overview
 |                                    |                                                             |                               |                                  |                         |
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
 
-Criteria
---------
-
 .. toctree::
    django-allauth
    django-debug-toolbar

docs/source/third-party-library-support/supported-libraries/wagtail.rst

@@ -0,0 +1,28 @@
+Wagtail
+=======
+
+.. _wagtail-results:
+
+Test suite
+----------
+
+Via ``dm repo test wagtail``
+
+.. note::
+
+    Test results prior to merging https://github.com/mongodb/django-mongodb-backend/pull/256
+
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  **PERCENTAGE PASSED**    | **TOTAL**  |  **PASS** | **FAIL**  |  **SKIPPED**   |   **ERROR**  | **EXPECTED FAILURES**      |  **WARNING**     |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+|  43%                      | 4897       |     2124  | 52        |        468     |       2252   |                    1       |   0              |
++---------------------------+------------+-----------+-----------+----------------+--------------+----------------------------+------------------+
+
+- `wagtail.txt <../_static/wagtail.txt>`_
+- `wagtail2.txt <../_static/wagtail2.txt>`_
+
+Project examples
+----------------
+
+Known issues
+------------

justfile

@@ -92,7 +92,8 @@ alias b := sphinx-build
 
 [group('sphinx')]
 sphinx-serve:
-    cd docs/_build && python -m http.server
+    # cd docs/_build && python -m http.server
+    sphinx-autobuild docs/source docs/_build
 alias ss := sphinx-serve
 
 [group('sphinx')]

pyproject.toml

@@ -25,6 +25,7 @@ dependencies = [
     "requests-oauthlib",  # For django-allauth
     "rich",
     "setuptools",  # For django-rest-framework
+    "sphinx-autobuild",  # For django-mongodb-backend documentation
     "toml",
 ]
 
@@ -48,7 +49,7 @@ dev = [
     "flask-pymongo @ git+ssh://git@github.com/mongodb-labs/flask-pymongo",
     "langchain-mongodb @ git+ssh://git@github.com/langchain-ai/langchain-mongodb@main",
     "mongo-python-driver @ git+ssh://git@github.com/mongodb/mongo-python-driver@master",
-    "specifications @ git+ssh://git@github.com:mongodb/specifications@master",
+    "specifications @ git+ssh://git@github.com/mongodb/specifications@master",
     "wagtail @ git+ssh://git@github.com/mongodb-forks/wagtail@main",
     "wagtail-mongodb-project @ git+ssh://git@github.com/mongodb-labs/wagtail-mongodb-project@main",
     "xmlsec @ git+ssh://git@github.com/xmlsec/python-xmlsec@main",