[DOCS] Add dark mode to documentation (#58)

This commit adds dark mode to the documentation and adds documentation build output folder to .gitignore
ObaraEmmanuel · Jan 17, 2025 · 320e3a0 · 320e3a0
1 parent 192fc81
commit 320e3a0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,6 @@ MANIFEST
 *.manifest
 *.spec
 .idea/
+
+# extra for documantation builds
+docs/_build/
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,9 +33,12 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx_rtd_theme'
+    'sphinx_rtd_theme',
+    'sphinx_rtd_dark_mode',
 ]
 
+default_dark_mode = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 Sphinx==8.1.3
-sphinx-rtd-theme==3.0.2
+sphinx-rtd-theme==3.0.2
+sphinx-rtd-dark-mode==1.3.0