From 74c26cb72816d2c2337ff275e7e6f9b126c95164 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Tue, 22 Apr 2025 17:20:58 -0400 Subject: [PATCH] Update docs --- docs/source/conf.py | 2 +- docs/source/index.rst | 7 ++----- docs/source/installation/index.rst | 4 ++-- pyproject.toml | 1 + 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d232c54..1680658 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 = [] diff --git a/docs/source/index.rst b/docs/source/index.rst index 7edd2c2..a13771c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,11 +16,8 @@ About This library provides the ``dm`` command which can be used for: -- Testing - - - - :ref:`Third party library test suites ` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_. - - `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries `. +- :ref:`Running third party library test suites ` with `Django MongoDB Backend`_ and MongoDB's `Django fork`_. +- Creating `Django projects`_ with `Django MongoDB Backend`_ and :ref:`third party libraries `. Table of Contents ----------------- diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst index 94ae519..a974893 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/installation/index.rst @@ -19,8 +19,8 @@ Create a virtual environment source .venv/bin/activate -Install CLI ------------ +Install ``dm`` command +---------------------- :: diff --git a/pyproject.toml b/pyproject.toml index 7720e0c..cad4f8f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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", ]