ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-22 06:17:50 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Use sphinx_rtd_theme when building docs locally

Browse Source 
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.
This commit is contained in:
Sajith Sasidharan 2021-03-09 15:42:48 -05:00
parent a4a8a22f8f
commit 93dff0e6ad
3 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf.py
View File

@ -28,7 +28,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['recommonmark'] extensions = ['recommonmark', 'sphinx_rtd_theme']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] 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 # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the

0
newsfragments/3631.minor Normal file
View File

1
tox.ini
View File

@ -230,6 +230,7 @@ deps =
sphinx sphinx
docutils==0.12 docutils==0.12
recommonmark recommonmark
sphinx_rtd_theme
# normal install is not needed for docs, and slows things down # normal install is not needed for docs, and slows things down
skip_install = True skip_install = True
commands = commands =