Skip to content
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
6 changes: 1 addition & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,5 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_theme = "furo"
html_static_path = ["_static"]
html_theme_options = {
"show_relbar_top": False,
"show_relbar_bottom": True,
}
25 changes: 12 additions & 13 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,25 @@
Django MongoDB CLI
==================

.. note::
About
=====

This documentation is for MongoDB staff and developers of Django third
party libraries interested in supporting
:ref:`Django MongoDB Backend <django-mongodb-backend>`.
This library is for developers of third party Django libraries who want to add
compatibility with :ref:`Django MongoDB Backend <django-mongodb-backend>`.

End users of :ref:`Django MongoDB Backend <django-mongodb-backend>`
should read the `Django MongoDB Backend documentation`_.
The ``dm`` command line tool provides utilities for running tests for:

About
-----
- :ref:`Third party libraries <third-party-libraries>`
- :ref:`Django MongoDB Backend <django-mongodb-backend>`
- :ref:`MongoDB's Django fork <mongodb-django-fork>`

This library provides the ``dm`` command which can be used for:
.. admonition:: End users of Django MongoDB Backend

- :ref:`Running third party library test suites <third-party-libraries>` with
:ref:`Django MongoDB Backend <django-mongodb-backend>` and
:ref:`MongoDB's Django fork <mongodb-django-fork>`.
Please read the documentation for :ref:`Django MongoDB Backend
<django-mongodb-backend>`.

Table of Contents
-----------------
=================

.. toctree::
third-party-library-support/index
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ dependencies = [
"wagtail",
]

[project.optional-dependencies]
docs = [
"furo",
"sphinx-copybutton",
]

[project.scripts]
dm = "django_mongodb_cli:dm"

Expand Down