Skip to content

Update docs #18

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.

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 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []
extensions = ["sphinx_copybutton"]

templates_path = ["_templates"]
exclude_patterns = []
Expand Down
7 changes: 2 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,8 @@ About

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

- 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>`.
- :ref:`Running third party library test suites <third-party-libraries>` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_.
- Creating `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries <third-party-libraries>`.

Table of Contents
-----------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Create a virtual environment
source .venv/bin/activate


Install CLI
-----------
Install ``dm`` command
----------------------

::

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ dependencies = [
"rich",
"setuptools", # For django-rest-framework
"sphinx-autobuild", # For django-mongodb-backend documentation
"sphinx-copybutton", # For django-mongodb-backend documentation
"toml",
]

Expand Down