Skip to content

Update docs #14

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 1 commit into from
Apr 18, 2025
Merged

Update docs #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@ Django MongoDB CLI
Django MongoDB Backend should refer to the
`Django MongoDB Backend documentation`_.

About
-----

This library provides the ``dm`` command line utility which can be used for:

- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party libraries <third-party-libraries>` with the ``dm repo`` command.
- Testing `Django MongoDB Backend`_ projects with :ref:`third party libraries <third-party-libraries>` with the ``dm startproject`` command.
- 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 library integrations <third-party-libraries>`.

Table of Contents
-----------------
Expand All @@ -26,4 +29,4 @@ Table of Contents

.. _`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.0/
.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.1/