Skip to content

Commit ba9cc56

Browse files
authored
Use furo style for docs (#31)
Also: - Build documentation in nit-picky mode - Run sphinx-build from the docs directory when toxing
1 parent f4b61ae commit ba9cc56

2 files changed

Lines changed: 5 additions & 14 deletions

File tree

docs/conf.py

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

62-
# on_rtd is whether we are on readthedocs.org
63-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
64-
65-
if not on_rtd: # only import and set the theme if we're building docs locally
66-
import sphinx_rtd_theme
67-
html_theme = 'sphinx_rtd_theme'
68-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
62+
html_theme = 'furo'
6963

7064
# The name for this set of Sphinx documents.
7165
# "<project> v<release> documentation" by default.
7266
#
73-
html_title = '%s %s documentation' % (project, release)
74-
75-
# A shorter title for the navigation bar. Default is the same as html_title.
76-
#
77-
html_short_title = '%s %s documentation' % (project, version)
67+
html_title = project
7868

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

tox.ini

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ commands =
2323

2424
[testenv:docs]
2525
deps =
26+
furo
2627
sphinx
27-
sphinx_rtd_theme
2828
sphinxcontrib-runcmd
29-
commands = sphinx-build docs {envtmpdir} -E
29+
changedir = docs
30+
commands = sphinx-build . {envtmpdir} -E -n
3031

3132
[testenv:build]
3233
deps =

0 commit comments

Comments
 (0)