Skip to content

Commit ee6bd69

Browse files
committed
Improvements to the API docs output config
1 parent d345513 commit ee6bd69

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/conf.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@
101101
# This is required for the alabaster theme
102102
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
103103

104-
# Use the readthedocs theme if the documentation is being built there
104+
# Use the readthedocs theme if the documentation is being built there, or
105+
# use a Sphinx theme if the documentation is being built locally
105106
on_rtd = os.environ.get('READTHEDOCS') == 'True'
106107
if on_rtd:
107108
html_theme = 'default'
@@ -116,6 +117,17 @@
116117
'localtoc.html'
117118
]
118119
}
120+
# If you want to use the same theme as readthedocs, uncomment the lines
121+
# below and install the readthedocs theme (pip install sphinx_rtd_theme)
122+
# before doing a new build:
123+
#html_theme = 'sphinx_rtd_theme'
124+
#html_theme_options = {
125+
# 'collapse_navigation': False,
126+
#}
127+
128+
# Do not show the "View source" link that shows the .rst files
129+
html_copy_source = False
130+
html_show_sourcelink = False
119131

120132
# -- Options for HTMLHelp output ------------------------------------------
121133

0 commit comments

Comments
 (0)