abca6e975e
One conf.py was failing to pass falke8 and the other one was excluded. Removed exclusion and fixed these filex as this is a more future proof approach. Before this change a clean clone of this repository would have failed on `tox -e pep8`. Change-Id: Ib8337aa6129acb515e33846c0635b582d1eedb8b
131 lines
3.9 KiB
Python
131 lines
3.9 KiB
Python
# instack-undercloud documentation build configuration file, created by
|
|
# sphinx-quickstart on Wed Feb 25 10:56:57 2015.
|
|
#
|
|
# This file is execfile()d with the current directory set to its containing
|
|
# dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
# import os
|
|
# import sys
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
# needs_sphinx = '1.0'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'openstackdocstheme'
|
|
]
|
|
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The encoding of source files.
|
|
# source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'TripleO'
|
|
copyright = u'2015, OpenStack Foundation'
|
|
bug_tracker = u'Launchpad'
|
|
bug_tracker_url = u'https://launchpad.net/tripleo'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = '3.0.0'
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = '3.0.0'
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
# language = None
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
# non-false value, then it is used:
|
|
# today = ''
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
# today_fmt = '%B %d, %Y'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = []
|
|
|
|
# The reST default role (used for this markup: `text`) to use for all
|
|
# documents.
|
|
# default_role = None
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
# add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
# add_module_names = True
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
# output. They are ignored by default.
|
|
# show_authors = False
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
# modindex_common_prefix = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_static_path = ['../../_custom']
|
|
# html_style = 'custom.css'
|
|
templates_path = ['../../_templates']
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'openstackdocs'
|
|
|
|
# -- Options for LaTeX output ------------------------------------------------
|
|
|
|
latex_elements = {
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
# 'papersize': 'letterpaper',
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
# 'pointsize': '10pt',
|
|
|
|
# Additional stuff for the LaTeX preamble.
|
|
# 'preamble': '',
|
|
}
|
|
|
|
rst_prolog = """
|
|
.. |project| replace:: %s
|
|
.. |bug_tracker| replace:: %s
|
|
.. |bug_tracker_url| replace:: %s
|
|
""" % (project, bug_tracker, bug_tracker_url)
|
|
|
|
# openstackdocstheme options
|
|
repository_name = 'openstack/tripleo-docs'
|
|
bug_project = 'tripleo'
|
|
bug_tag = 'documentation'
|