From 93dff0e6adbe718a15e3479d0de21e4a978ac9d7 Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Tue, 9 Mar 2021 15:42:48 -0500 Subject: [PATCH] Use `sphinx_rtd_theme` when building docs locally Default theme that Sphinx uses is not consistent with what we have at https://tahoe-lafs.readthedocs.io. Being consistent with rtd might help future doc writers. --- docs/conf.py | 4 ++-- newsfragments/3631.minor | 0 tox.ini | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 newsfragments/3631.minor diff --git a/docs/conf.py b/docs/conf.py index 612c324a3..af05e5900 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ import os # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['recommonmark'] +extensions = ['recommonmark', 'sphinx_rtd_theme'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -107,7 +107,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/newsfragments/3631.minor b/newsfragments/3631.minor new file mode 100644 index 000000000..e69de29bb diff --git a/tox.ini b/tox.ini index 33e5830ff..8908142f4 100644 --- a/tox.ini +++ b/tox.ini @@ -230,6 +230,7 @@ deps = sphinx docutils==0.12 recommonmark + sphinx_rtd_theme # normal install is not needed for docs, and slows things down skip_install = True commands =