From 42f7fad86f56d4b455d64d4297fb6af9e6542bc1 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 29 Oct 2025 17:22:21 -0400 Subject: [PATCH 1/2] Switch to furo --- docs/source/conf.py | 6 +----- pyproject.toml | 6 ++++++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7ed1d43..aa6b168 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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, -} diff --git a/pyproject.toml b/pyproject.toml index dca9c5d..1e564b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,6 +45,12 @@ dependencies = [ "wagtail", ] +[project.optional-dependencies] +docs = [ + "furo", + "sphinx-copybutton", +] + [project.scripts] dm = "django_mongodb_cli:dm" From 9e6b87df607889a7f3feed86aa3fd085775e6b41 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Wed, 29 Oct 2025 17:40:02 -0400 Subject: [PATCH 2/2] Update About section --- docs/source/index.rst | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index b0b5fd1..e526f76 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 `. +This library is for developers of third party Django libraries who want to add +compatibility with :ref:`Django MongoDB Backend `. - End users of :ref:`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 ` +- :ref:`Django MongoDB Backend ` +- :ref:`MongoDB's 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 ` with - :ref:`Django MongoDB Backend ` and - :ref:`MongoDB's Django fork `. + Please read the documentation for :ref:`Django MongoDB Backend + `. Table of Contents ------------------ +================= .. toctree:: third-party-library-support/index