Skip to content

Commit 7c1a035

Browse files
committed
Use furo style for docs
Also: - Build documentation in nit-picky mode - Run sphinx-build from the docs directory when toxing - Bump ReadTheDocs build.os to ubuntu-24.04
1 parent a002d34 commit 7c1a035

4 files changed

Lines changed: 6 additions & 15 deletions

File tree

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 2
22

33
build:
4-
os: ubuntu-22.04
4+
os: ubuntu-24.04
55
tools:
66
python: "3"
77

docs/conf.py

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,22 +65,12 @@
6565
# The theme to use for HTML and HTML Help pages. See the documentation for
6666
# a list of builtin themes.
6767

68-
# on_rtd is whether we are on readthedocs.org
69-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
70-
71-
if not on_rtd: # only import and set the theme if we're building docs locally
72-
import sphinx_rtd_theme
73-
html_theme = 'sphinx_rtd_theme'
74-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
68+
html_theme = 'furo'
7569

7670
# The name for this set of Sphinx documents.
7771
# "<project> v<release> documentation" by default.
7872
#
79-
html_title = '%s %s documentation' % (project, release)
80-
81-
# A shorter title for the navigation bar. Default is the same as html_title.
82-
#
83-
html_short_title = '%s %s documentation' % (project, version)
73+
html_title = project
8474

8575
# Add any paths that contain custom static files (such as style sheets) here,
8676
# relative to this directory. They are copied after the builtin static files,

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1+
furo
12
sphinx>=5.2
2-
sphinx_rtd_theme
33
sphinxcontrib-runcmd

tox.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ commands =
3333

3434
[testenv:docs]
3535
deps = -rdocs/requirements.txt
36-
commands = sphinx-build docs {envtmpdir} -E
36+
changedir = docs
37+
commands = sphinx-build . {envtmpdir} -E -n
3738

3839
[testenv:build]
3940
deps =

0 commit comments

Comments
 (0)