Skip to content

Update docs #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2025
Merged

Update docs #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a60f996
Update django-mongodb-backend usage docs
aclark4life Apr 23, 2025
b7c5209
Update django-mongodb-backend usage docs
aclark4life Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/_static/images/django-mongodb-backend.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/images/django-mongodb-backend2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Table of Contents

.. toctree::
installation
usage
usage/index
third-party-library-support/index
supported-libraries/index
glossary
Expand Down
28 changes: 28 additions & 0 deletions docs/source/usage/django-mongodb-backend.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions docs/source/usage/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Usage
=====

.. toctree::
third-party
django-mongodb-backend
25 changes: 11 additions & 14 deletions docs/source/usage.rst → docs/source/usage/third-party.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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::

Expand All @@ -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