Skip to content

Commit f3a0c6e

Browse files
authored
Change the documentation theme to Furo (#244)
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/
1 parent 541827c commit f3a0c6e

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

docs/conf.py

+1-7
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494

9595
# The theme to use for HTML and HTML Help pages. See the documentation for
9696
# a list of builtin themes.
97-
html_theme = 'default'
97+
html_theme = 'furo'
9898

9999
# Theme options are theme-specific and customize the look and feel of a theme
100100
# further. For a list of options available for each theme, see the
@@ -133,12 +133,6 @@
133133
# typographically correct entities.
134134
# html_use_smartypants = True
135135

136-
# Custom sidebar templates, maps document names to template names.
137-
html_sidebars = {
138-
'index': ('sidebar.html', 'sourcelink.html', 'searchbox.html'),
139-
'**': ('localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'),
140-
}
141-
142136
# Additional templates that should be rendered to pages, maps page names to
143137
# template names.
144138
# html_additional_pages = {}

requirements-docs.in

+1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
# pip install -r requirements-docs.in && pip freeze > requirements-docs.txt
66
#
77
# and then modifying the file manually to restrict black and mypy to CPython
8+
furo
89
sphinx

requirements-docs.txt

+4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
alabaster==0.7.13
22
babel==2.14.0
3+
beautifulsoup4==4.12.3
34
certifi==2024.7.4
45
charset-normalizer==3.3.2
56
docutils==0.20.1
7+
furo==2024.5.6
68
idna==3.7
79
imagesize==1.4.1
810
importlib-metadata==7.0.0
@@ -13,7 +15,9 @@ pygments==2.17.2
1315
pytz==2023.3.post1
1416
requests==2.32.2
1517
snowballstemmer==2.2.0
18+
soupsieve==2.5
1619
sphinx==7.1.2
20+
sphinx-basic-ng==1.0.0b2
1721
sphinxcontrib-applehelp==1.0.4
1822
sphinxcontrib-devhelp==1.0.2
1923
sphinxcontrib-htmlhelp==2.0.1

0 commit comments

Comments
 (0)