Skip to content

Commit b6e36e1

Browse files
committed
Use sphinx RTD theme for docs
1 parent 6fef563 commit b6e36e1

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

docs/conf.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@
3232
# Add any Sphinx extension module names here, as strings. They can be
3333
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3434
# ones.
35-
extensions = ["sphinx.ext.viewcode"]
35+
extensions = [
36+
"sphinx.ext.viewcode",
37+
"sphinx_rtd_theme",
38+
]
3639

3740
# Add any paths that contain templates here, relative to this directory.
3841
templates_path = ["_templates"]
@@ -65,7 +68,7 @@
6568
#
6669
# This is also used if you do content translation via gettext catalogs.
6770
# Usually you set "language" from the command line for these cases.
68-
language = None
71+
language = "en"
6972

7073
# List of patterns, relative to source directory, that match files and
7174
# directories to ignore when looking for source files.
@@ -84,7 +87,7 @@
8487
# The theme to use for HTML and HTML Help pages. See the documentation for
8588
# a list of builtin themes.
8689
#
87-
html_theme = "default"
90+
html_theme = "sphinx_rtd_theme"
8891

8992
# Theme options are theme-specific and customize the look and feel of a theme
9093
# further. For a list of options available for each theme, see the

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
sphinx>=4.3.0
2-
sphinx-rtd-theme>=1.2.0rc3,<1.3
1+
sphinx==8.2.3
2+
sphinx-rtd-theme==3.0.2

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ dev = [
4949
"tox>=4.24.1",
5050
"pytest-cov>=6.0.0",
5151
"pre-commit-uv>=4.1.4",
52+
"sphinx>=7.4.7",
53+
"sphinx-rtd-theme>=3.0.2",
5254
]
5355

5456
[tool.setuptools]

0 commit comments

Comments
 (0)