Add dark mode toggle in documentation.

Signed-off-by: swastik <[email protected]>
aboutcode-org · Apr 21, 2023 · d98aac9 · d98aac9
1 parent 3abdc3f
commit d98aac9
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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
@@ -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