Use RTD theme

This commit is contained in:
Anders Ingemann 2014-05-04 19:11:33 +02:00
parent 3cc84c95e8
commit ee6df57f3f

View file

@ -28,11 +28,10 @@ sys.path.insert(0, os.path.abspath(os.pardir))
# 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 = [ extensions = ['sphinx.ext.coverage',
'sphinx.ext.coverage', 'sphinx.ext.autodoc',
'sphinx.ext.autodoc', 'sphinx.ext.viewcode',
'sphinx.ext.viewcode', ]
]
# 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']
@ -103,7 +102,14 @@ pygments_style = 'sphinx'
# 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'
# 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 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_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
@ -200,7 +206,7 @@ latex_elements = {}
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [('index', 'bootstrap-vz.tex', u'bootstrap-vz Documentation', latex_documents = [('index', 'bootstrap-vz.tex', u'bootstrap-vz Documentation',
u'Anders Ingemann', 'manual'), u'Anders Ingemann', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -228,10 +234,7 @@ latex_documents = [('index', 'bootstrap-vz.tex', u'bootstrap-vz Documentation',
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation', [u'Anders Ingemann'], 1)]
('index', 'bootstrap-vz', u'bootstrap-vz Documentation',
[u'Anders Ingemann'], 1)
]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
#man_show_urls = False #man_show_urls = False
@ -243,8 +246,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation', texinfo_documents = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation',
u'Anders Ingemann', 'bootstrap-vz', 'One line description of project.', u'Anders Ingemann', 'bootstrap-vz', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.