diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7e275c65c..bad90a858 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,10 @@ Release notes ============= +Next Release +------------- + +- We added dark mode toggle in the documentation. Next release ------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index 682892887..9ae0687d7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ Sphinx>=3.3.1 sphinx-rtd-theme>=0.5.0 doc8>=0.8.1 +sphinx-rtd-dark-mode diff --git a/docs/source/conf.py b/docs/source/conf.py index 94f2c1d60..f691a063c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,7 +39,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ["sphinx_rtd_dark_mode"] # For the dark mode # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -63,3 +63,7 @@ html_static_path = [] master_doc = "index" + +# user starts in light mode + +default_dark_mode = False diff --git a/requirements.txt b/requirements.txt index 729b349c4..bf5a7bd96 100644 --- a/requirements.txt +++ b/requirements.txt @@ -92,6 +92,7 @@ snowballstemmer==2.2.0 soupsieve==2.3.2 Sphinx==4.5.0 sphinx-rtd-theme==1.0.0 +sphinx-rtd-dark-mode==1.2.4 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-django2==1.5