diff --git a/docs/source/index.rst b/docs/source/index.rst index 04479fe..d060742 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,9 +26,9 @@ Table of Contents ----------------- .. toctree:: + third-party-library-support/index installation usage/index - third-party-library-support/index supported-libraries/index glossary diff --git a/docs/source/third-party-library-support/index.rst b/docs/source/third-party-library-support/index.rst index a6f58de..9952760 100644 --- a/docs/source/third-party-library-support/index.rst +++ b/docs/source/third-party-library-support/index.rst @@ -1,9 +1,15 @@ Third party library support =========================== -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. +A third party library supported when the following criteria are met: + +.. note:: + + This is the criteria used to determine if a third party library is + supported by :ref:`Django MongoDB Backend <django-mongodb-backend>`. + + It is not a guarantee that the library will work without issues, + just that these criteria have been met. .. toctree:: test-suites diff --git a/docs/source/third-party-library-support/test-suites.rst b/docs/source/third-party-library-support/test-suites.rst index d6da660..3212384 100644 --- a/docs/source/third-party-library-support/test-suites.rst +++ b/docs/source/third-party-library-support/test-suites.rst @@ -5,26 +5,26 @@ Test suites For each third party library that is supported, the following tasks are performed: -- The test suite is configured to run with Django MongoDB Backend +#. **The test suite is configured to run with Django MongoDB Backend.** - - Evaluate test runner configuration + a. Evaluate test runner configuration - - Depending on the test runner, updating the settings may require copying - ``mongo_apps.py`` and ``mongo_migrations`` to a module that is already - included in ``sys.path``. + i. Depending on the test runner, updating the settings may require + copying ``mongo_apps.py`` and ``mongo_migrations`` to a module that is + already included in ``sys.path``. - - Update django settings + b. Update django settings - - Replace the database backend with ``django_mongodb_backend`` - - Replace contrib apps with MongoDB compatible apps - - Replace test suite apps with MongoDB compatible apps + i. Replace the database backend with ``django_mongodb_backend`` + #. Replace contrib apps with MongoDB compatible apps + #. Replace test suite apps with MongoDB compatible apps - - Update or disable migrations + c. Update or disable migrations - - Use MongoDB compatible migrations if not disabled + i. Use MongoDB compatible migrations if not disabled -- The test suite is run with Django MongoDB Backend -- The test results are recorded -- The test suite is updated +2. **The test suite is run with Django MongoDB Backend configured.** +#. **The test run results are logged.** +#. **The test suite tests are updated as needed.** - - Replace static primary key references with dynamic references or static ``ObjectId`` references + a. Replace static primary key references with dynamic references or static ``ObjectId`` references diff --git a/docs/source/usage/third-party.rst b/docs/source/usage/third-party.rst index 4337b08..7eca797 100644 --- a/docs/source/usage/third-party.rst +++ b/docs/source/usage/third-party.rst @@ -8,7 +8,7 @@ django-filter dm repo test django-filter -When completed successfully the output should look something like this: +When completed successfully the output will look like this: .. image:: ../_static/images/django-filter.png @@ -19,7 +19,7 @@ django-rest-framework dm repo test django-rest-framework -When completed successfully the output should look something like this: +When completed successfully the output will look like this: .. image:: ../_static/images/django-rest-framework.png @@ -30,7 +30,7 @@ django-debug-toolbar dm repo test django-debug-toolbar -When completed successfully the output should look something like this: +When completed successfully the output will look like this: .. image:: ../_static/images/django-debug-toolbar.png @@ -48,7 +48,7 @@ django-allauth dm repo test django-allauth -When completed successfully the output should look something like this: +When completed successfully the output will look like this: .. image:: ../_static/images/django-allauth.png @@ -59,6 +59,6 @@ wagtail dm repo test wagtail -When completed successfully the output should look something like this: +When completed successfully the output will look like this: .. image:: ../_static/images/wagtail.png