149 lines
4.7 KiB
Python
149 lines
4.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
# flake8: noqa
|
|
|
|
# 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.
|
|
#
|
|
# 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.
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
__metaclass__ = type
|
|
# 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 = []
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
html_theme_options = {}
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# 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 = "TripleO"
|
|
copyright = "2016, RDO CI Team"
|
|
bug_tracker = "Bugzilla"
|
|
bug_tracker_url = "https://bugzilla.redhat.com"
|
|
|
|
# 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"
|
|
html_last_updated_fmt = "%b %d, %Y"
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = "tripleo-documentor"
|
|
|
|
html_show_sourcelink = True
|
|
html_show_sphinx = True
|
|
html_show_copyright = True
|
|
|
|
# -- 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,
|
|
)
|