Add theme options

This commit is contained in:
cytopia 2018-03-10 12:11:25 +01:00
parent 0f28572ef1
commit 76936c9afd
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2

View File

@ -5,6 +5,7 @@
# This file does only contain a selection of the most common options. For a # This file does only contain a selection of the most common options. For a
# full list see the documentation: # full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config # http://www.sphinx-doc.org/en/stable/config
import os
# -- Path setup -------------------------------------------------------------- # -- Path setup --------------------------------------------------------------
@ -15,7 +16,6 @@
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme
from recommonmark.parser import CommonMarkParser from recommonmark.parser import CommonMarkParser
@ -33,6 +33,9 @@ release = u''
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
# #
# needs_sphinx = '1.0' # needs_sphinx = '1.0'
@ -77,13 +80,38 @@ pygments_style = 'sphinx'
# a list of builtin themes. # a list of builtin themes.
# #
#html_theme = 'alabaster' #html_theme = 'alabaster'
#html_theme = 'sphinx_rtd_theme'
html_theme = 'default'
# From:
# * https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# 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
# documentation. # documentation.
# #
# html_theme_options = {} # html_theme_options = {}
# https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#project-wide-configuration
#html_theme_options = {
# 'canonical_url': '',
# 'analytics_id': '',
# 'logo_only': False,
# 'display_version': True,
# 'prev_next_buttons_location': 'bottom',
# 'style_external_links': False,
# #'vcs_pageview_mode': '',
# # Toc options
# 'collapse_navigation': False,
# 'sticky_navigation': True,
# 'navigation_depth': 4,
# #'includehidden': True,
# 'titles_only': False
#}
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,