Skip to content

Commit 5308e8d

Browse files
committed
Use furo as theme for documentation
- the old theme didn't support dark mode
1 parent c99515a commit 5308e8d

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

.readthedocs.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ build:
1111
sphinx:
1212
configuration: docs/source/conf.py
1313
fail_on_warning: true
14+
15+
python:
16+
install:
17+
- requirements: docs/requirements.txt

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
* use trusted publisher for release (see https://docs.pypi.org/trusted-publishers/)
1010
* use `pyproject.toml` for project setup
1111

12+
### Documentation
13+
* use a theme for documentation supporting dark mode
14+
1215
### Documentation
1316
* added use case for ordering test modules (see [#51](https://github.com/pytest-dev/pytest-order/issues/51))
1417

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
sphinx>=2.3.1
2+
furo

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104

105105
# The theme to use for HTML and HTML Help pages. See the documentation for
106106
# a list of builtin themes.
107-
html_theme = "nature"
107+
html_theme = "furo"
108108

109109
# Theme options are theme-specific and customize the look and feel of a theme
110110
# further. For a list of options available for each theme, see the
@@ -165,7 +165,7 @@
165165
# html_split_index = False
166166

167167
# If true, links to the reST sources are added to the pages.
168-
# html_show_sourcelink = True
168+
html_show_sourcelink = False
169169

170170
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171171
html_show_sphinx = False

0 commit comments

Comments
 (0)