Skip to content

Commit f03582f

Browse files
authored
Explicitly select readthedocs theme (Gallopsled#2311)
The `sphinx_rtd_theme` has to be selected manually and isn't the default on RTD anymore. This seems to be part of a wave of deprecations in their build system. https://github.com/readthedocs/tutorial-template/blob/f594c40889a4d9949339bd4e0d64275fc99c22f5/docs/source/conf.py#L32
1 parent d10c70f commit f03582f

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.readthedocs.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ build:
77
tools:
88
python: "3"
99

10+
sphinx:
11+
configuration: docs/source/conf.py
12+
1013
python:
1114
install:
1215
- requirements: docs/requirements.txt

docs/source/conf.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ def __setattr__(self, name, value):
169169

170170
# The theme to use for HTML and HTML Help pages. See the documentation for
171171
# a list of builtin themes.
172-
html_theme = 'default'
172+
html_theme = 'sphinx_rtd_theme'
173173

174174
# Theme options are theme-specific and customize the look and feel of a theme
175175
# further. For a list of options available for each theme, see the
@@ -265,8 +265,8 @@ def __setattr__(self, name, value):
265265
u'2016, Gallopsled et al.', 'manual'),
266266
]
267267

268-
intersphinx_mapping = {'python': ('https://docs.python.org/3.8', None),
269-
'paramiko': ('https://paramiko-docs.readthedocs.org/en/2.1/', None)}
268+
intersphinx_mapping = {'python': ('https://docs.python.org/3/', None),
269+
'paramiko': ('https://docs.paramiko.org/en/2.1/', None)}
270270

271271
# The name of an image file (relative to this directory) to place at the top of
272272
# the title page.
@@ -382,8 +382,6 @@ def linkcode_resolve(domain, info):
382382
html_theme_path = [alabaster.get_path()]
383383
html_theme_options = { 'nosidebar' : True }
384384

385-
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
386-
387385

388386
# -- Customization to Sphinx autodoc generation --------------------------------------------
389387
import sphinx.ext.autodoc

0 commit comments

Comments
 (0)