Skip to content

Commit 09341ab

Browse files
committed
Update docs theme.
1 parent 6defaff commit 09341ab

4 files changed

Lines changed: 86 additions & 11 deletions

File tree

‎.readthedocs.yaml‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,11 @@ sphinx:
2727
# - pdf
2828
# - epub
2929

30-
# Optional but recommended, declare the Python requirements required
31-
# to build your documentation
32-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33-
# python:
34-
# install:
35-
# - requirements: docs/requirements.txt
30+
# Install the package itself (autodoc imports it) together with the
31+
# documentation dependencies declared in pyproject.toml.
32+
python:
33+
install:
34+
- method: pip
35+
path: .
36+
extra_requirements:
37+
- doc

‎docs/source/conf.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,18 @@
8484
#show_authors = False
8585

8686
# The name of the Pygments (syntax highlighting) style to use.
87-
pygments_style = 'tango'
87+
# Not set on purpose: the furo theme ships a light and a dark highlighting
88+
# style and selects the one matching the reader's color scheme.
89+
#pygments_style = 'tango'
8890

8991
# A list of ignored prefixes for module index sorting.
9092
#modindex_common_prefix = []
9193

9294

9395
# -- Options for HTML output ---------------------------------------------------
9496

95-
# The theme to use for HTML and HTML Help pages. Major themes that come with
96-
# Sphinx are currently 'default' and 'sphinxdoc'.
97-
#html_theme = 'agogo'
97+
# The theme to use for HTML and HTML Help pages.
98+
html_theme = 'furo'
9899

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

‎pyproject.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ dev = [
4444
]
4545
doc = [
4646
"sphinx",
47+
"furo",
4748
]
4849

4950
[tool.hatch.version]
@@ -74,6 +75,7 @@ dev = [
7475
"ruff",
7576
"build",
7677
"sphinx",
78+
"furo",
7779
]
7880

7981
[tool.ruff]

‎uv.lock‎

Lines changed: 71 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)