Skip to content

Commit 0e5e149

Browse files
authored
Merge pull request #46 from aclark4life/main
Switch to furo
2 parents a5d283f + 9e6b87d commit 0e5e149

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

docs/source/conf.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,5 @@
2323
# -- Options for HTML output -------------------------------------------------
2424
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
2525

26-
html_theme = "alabaster"
26+
html_theme = "furo"
2727
html_static_path = ["_static"]
28-
html_theme_options = {
29-
"show_relbar_top": False,
30-
"show_relbar_bottom": True,
31-
}

docs/source/index.rst

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,25 @@
22
Django MongoDB CLI
33
==================
44

5-
.. note::
5+
About
6+
=====
67

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

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

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

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

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

2322
Table of Contents
24-
-----------------
23+
=================
2524

2625
.. toctree::
2726
third-party-library-support/index

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ dependencies = [
4545
"wagtail",
4646
]
4747

48+
[project.optional-dependencies]
49+
docs = [
50+
"furo",
51+
"sphinx-copybutton",
52+
]
53+
4854
[project.scripts]
4955
dm = "django_mongodb_cli:dm"
5056

0 commit comments

Comments
 (0)