Change the documentation theme to Furo

The default one feels a bit outdated to me, let's try this[1]. I initially wanted to go with the RTD theme but it doesn't support dark mode natively[2]. The theme is used in Python Developer's Guide[3] and it looks nice in my opinion. [1] https://github.com/pradyunsg/furo#elevator-pitch [2] readthedocs/sphinx_rtd_theme#224 [3] https://devguide.python.org/
python-injector · Dec 13, 2023 · 59a199a · 59a199a
1 parent dc5081d
commit 59a199a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -94,7 +94,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'furo'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/requirements-docs.in b/requirements-docs.in
@@ -5,4 +5,5 @@
 #     pip install -r requirements-docs.in && pip freeze > requirements-docs.txt
 #
 # and then modifying the file manually to restrict black and mypy to CPython
+furo
 sphinx
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,8 +1,10 @@
 alabaster==0.7.13
 Babel==2.14.0
+beautifulsoup4==4.12.2
 certifi==2023.11.17
 charset-normalizer==3.3.2
 docutils==0.20.1
+furo==2023.9.10
 idna==3.6
 imagesize==1.4.1
 importlib-metadata==7.0.0
@@ -13,7 +15,9 @@ pygments==2.17.2
 pytz==2023.3.post1
 requests==2.31.0
 snowballstemmer==2.2.0
+soupsieve==2.5
 sphinx==7.1.2
+sphinx-basic-ng==1.0.0b2
 sphinxcontrib-applehelp==1.0.4
 sphinxcontrib-devhelp==1.0.2
 sphinxcontrib-htmlhelp==2.0.1
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,4 +5,5 @@ @@
     #     pip install -r requirements-docs.in && pip freeze > requirements-docs.txt
     #
     # and then modifying the file manually to restrict black and mypy to CPython
+    furo
     sphinx