Merge pull request #13 from aclark4life/main

Update docs

Author: aclark4life

Diff for: config/extensions/debug_toolbar_settings.py

@@ -24,9 +24,9 @@
 # Application definition
 
 INSTALLED_APPS = [
-    "django_mongodb_extensions.debug_toolbar.mongo_apps.MongoAdminConfig",
-    "django_mongodb_extensions.debug_toolbar.mongo_apps.MongoAuthConfig",
-    "django_mongodb_extensions.debug_toolbar.mongo_apps.MongoContentTypesConfig",
+    "django_mongodb_extensions.mongo_apps.MongoAdminConfig",
+    "django_mongodb_extensions.mongo_apps.MongoAuthConfig",
+    "django_mongodb_extensions.mongo_apps.MongoContentTypesConfig",
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",

Diff for: docs/source/index.rst

@@ -21,7 +21,7 @@ Table of Contents
    :maxdepth: 2
 
    installation/index
-   third-party-library-support
+   third-party-library-support/index
    supported-libraries/index
 
 .. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend

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

@@ -1,8 +1,51 @@
 Installation
 ============
 
+Clone the repository
+--------------------
 
-.. toctree::
-   clone-repository
-   venv
-   usage
+::
+
+    git clone https://github.com/mongodb-labs/django-mongodb-cli
+    cd django-mongodb-cli
+
+
+Create a virtual environment
+----------------------------
+
+::
+
+    python -m venv .venv
+    source .venv/bin/activate
+
+
+Install CLI
+-----------
+
+::
+
+    python -m pip install -e .
+
+Install development dependencies
+--------------------------------
+
+::
+
+    dm repo clone -a
+
+Usage
+-----
+
+.. code:: bash
+
+    $ dm --help
+    Usage: dm [OPTIONS] COMMAND [ARGS]...
+
+      Django MongoDB CLI
+
+    Options:
+      --help  Show this message and exit.
+
+    Commands:
+      repo          Run Django fork and third-party library tests.
+      startproject  Run `startproject` with custom templates.

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

@@ -3,8 +3,11 @@ Django allauth
 
 .. _django-allauth-results:
 
+Test suite
+----------
+
 Results
--------
+~~~~~~~
 
 Via ``dm repo test django-filter``
 
@@ -17,7 +20,7 @@ Via ``dm repo test django-filter``
 - `django-filter.txt <../_static/django-filter.txt>`_
 
 Settings
---------
+~~~~~~~~
 
 Via ``dm repo test django-filter --show``
 
@@ -78,7 +81,7 @@ Via ``dm repo test django-filter --show``
     }
 
 Tests
------
+~~~~~
 
 Via ``dm repo test django-filter -l``
 
@@ -209,3 +212,9 @@ Via ``dm repo test django-filter -l``
         ├── headless_only
         ├── login_required_mw
         └── regular
+
+Project examples
+----------------
+
+Known issues
+------------

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

@@ -4,10 +4,13 @@
 Supported libraries
 ===================
 
+Overview
+--------
+
 |
 
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
-| **Library**                        |  **Test suites**                                            |    **Project examples**       |   **Known limitations**          |    **Notes**            |
+| **Library**                        |  **Test suites**                                            |    **Project examples**       |   **Known issues**               |    **Notes**            |
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
 | **django-allauth**                 |        :ref:`63% passing <django-allauth-results>`          |                               |                                  |                         |
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
@@ -30,6 +33,9 @@ Supported libraries
 |                                    |                                                             |                               |                                  |                         |
 +------------------------------------+-------------------------------------------------------------+-------------------------------+----------------------------------+-------------------------+
 
+Criteria
+--------
+
 .. toctree::
    django-allauth
    django-debug-toolbar

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

@@ -0,0 +1,17 @@
+Third party library support
+===========================
+
+Definition
+-----------
+
+This is the criteria used to determine if a third party library is supported
+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

Diff for: docs/source/supported-libraries/django-allauth.rst

@@ -0,0 +1,4 @@
+.. _`known_issues`:
+
+Known issues
+------------

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

@@ -0,0 +1,4 @@
+.. _`project_examples`:
+
+Project examples
+----------------

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

@@ -1,18 +1,3 @@
-Third party library support
-===========================
-
-.. note::
-
-   This is the criteria used to determine if a third party library is supported
-   by Django MongoDB Backend. It is not a guarantee that the library will
-   work without issues, just that these criteria have been met.
-
-Support for third party libraries is determined via the following:
-
-- :ref:`Test suites <test_suites>`
-- :ref:`Project examples <project_examples>`
-- :ref:`Known limitations <known_limitations>`
-
 .. _test_suites:
 
 Test suites
@@ -43,15 +28,3 @@ For each third party library that is supported, the following tasks are performe
 - The test suite is updated
 
   - Replace static primary key references with dynamic references or static ``ObjectId`` references
-
-.. _`project_examples`:
-
-Project examples
-----------------
-
-.. _`known_limitations`:
-
-Known limitations
------------------
-
-- URL configuration