Skip to content

Commit 520bc81

Browse files
committed
docs/conf.py: added import of sphinx_rtd_theme, updated copyright to include 2018, made html_static_path = [] to prevent waring on RTD build (see readthedocs/readthedocs.org#1776)
1 parent 52177ad commit 520bc81

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

docs/conf.py

+15-7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
#
2121
import os
2222
import sys
23+
import sphinx_rtd_theme
2324
from sphinx.ext.autodoc import between
2425
# from unittest.mock import MagicMock
2526

@@ -57,7 +58,7 @@
5758

5859
# General information about the project.
5960
project = 'bapsflib'
60-
copyright = '2017, Erik T. Everson'
61+
copyright = '2017-2018, Erik T. Everson'
6162
author = 'Erik T. Everson'
6263

6364
# The version info for the project you're documenting, acts as
@@ -96,11 +97,12 @@
9697
#
9798
#html_theme = 'alabaster'
9899
#html_theme = 'default'
99-
on_rtd = os.environ.get('READTHEDOCS') == 'True'
100-
if on_rtd:
101-
html_theme = 'default'
102-
else:
103-
html_theme = 'sphinx_rtd_theme'
100+
#on_rtd = os.environ.get('READTHEDOCS') == 'True'
101+
#if on_rtd:
102+
# html_theme = 'default'
103+
#else:
104+
# html_theme = 'sphinx_rtd_theme'
105+
html_theme = 'sphinx_rtd_theme'
104106

105107
# Theme options are theme-specific and customize the look and feel of a
106108
# theme further. For a list of options available for each theme, see
@@ -114,7 +116,13 @@
114116
# here, relative to this directory. They are copied after the builtin
115117
# static files, so a file named "default.css" will overwrite the builtin
116118
# "default.css".
117-
html_static_path = ['_static']
119+
# - attempt to solve RTD from throwing a WARNING: html_static_theme
120+
# entry ... does not exist
121+
# - see issue #1776 on rtfd/readthedocs.org
122+
# (https://github.com/rtfd/readthedocs.org/issues/1776)
123+
#
124+
# html_static_path = ['_static']
125+
html_static_path = []
118126

119127
# Custom sidebar templates, must be a dictionary that maps document
120128
# names to template names.

0 commit comments

Comments
 (0)