From 320e3a0dcc5a51486687568cefba9f1eed853159 Mon Sep 17 00:00:00 2001 From: Berk Efe Keskin <92454444+berk-efe@users.noreply.github.com> Date: Fri, 17 Jan 2025 17:12:30 +0300 Subject: [PATCH] [DOCS] Add dark mode to documentation (#58) This commit adds dark mode to the documentation and adds documentation build output folder to .gitignore --- .gitignore | 3 +++ docs/conf.py | 5 ++++- docs/requirements.txt | 3 ++- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 592b575..ff0b596 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,6 @@ MANIFEST *.manifest *.spec .idea/ + +# extra for documantation builds +docs/_build/ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 32c547c..2074b24 100644 --- 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 index 8d0ed49..a6c105e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ Sphinx==8.1.3 -sphinx-rtd-theme==3.0.2 \ No newline at end of file +sphinx-rtd-theme==3.0.2 +sphinx-rtd-dark-mode==1.3.0 \ No newline at end of file