Skip to content

Commit 320e3a0

Browse files
authored
[DOCS] Add dark mode to documentation (#58)
This commit adds dark mode to the documentation and adds documentation build output folder to .gitignore
1 parent 192fc81 commit 320e3a0

3 files changed

Lines changed: 9 additions & 2 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,6 @@ MANIFEST
2525
*.manifest
2626
*.spec
2727
.idea/
28+
29+
# extra for documantation builds
30+
docs/_build/

docs/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,12 @@
3333
# ones.
3434
extensions = [
3535
'sphinx.ext.autodoc',
36-
'sphinx_rtd_theme'
36+
'sphinx_rtd_theme',
37+
'sphinx_rtd_dark_mode',
3738
]
3839

40+
default_dark_mode = False
41+
3942
# Add any paths that contain templates here, relative to this directory.
4043
templates_path = ['_templates']
4144

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
Sphinx==8.1.3
2-
sphinx-rtd-theme==3.0.2
2+
sphinx-rtd-theme==3.0.2
3+
sphinx-rtd-dark-mode==1.3.0

0 commit comments

Comments
 (0)