| 0 | |
# -*- coding: utf-8 -*-
|
| 1 | |
# Licensed under the Apache License, Version 2.0 (the "License");
|
| 2 | |
# you may not use this file except in compliance with the License.
|
| 3 | |
# You may obtain a copy of the License at
|
| 4 | |
#
|
| 5 | |
# http://www.apache.org/licenses/LICENSE-2.0
|
| 6 | |
#
|
| 7 | |
# Unless required by applicable law or agreed to in writing, software
|
| 8 | |
# distributed under the License is distributed on an "AS IS" BASIS,
|
| 9 | |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
| 10 | |
# implied.
|
| 11 | |
# See the License for the specific language governing permissions and
|
| 12 | |
# limitations under the License.
|
| 13 | |
|
| 14 | |
# This file is execfile()d with the current directory set to its
|
| 15 | |
# containing dir.
|
| 16 | |
#
|
| 17 | |
# Note that not all possible configuration values are present in this
|
| 18 | |
# autogenerated file.
|
| 19 | |
#
|
| 20 | |
# All configuration values have a default; values that are commented out
|
| 21 | |
# serve to show the default.
|
| 22 | |
|
| 23 | |
# If extensions (or modules to document with autodoc) are in another directory,
|
| 24 | |
# add these directories to sys.path here. If the directory is relative to the
|
| 25 | |
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
| 26 | |
# sys.path.insert(0, os.path.abspath('.'))
|
| 27 | |
|
| 28 | |
# -- General configuration ------------------------------------------------
|
| 29 | |
|
| 30 | |
# If your documentation needs a minimal Sphinx version, state it here.
|
| 31 | |
# needs_sphinx = '1.0'
|
| 32 | |
|
| 33 | |
# Add any Sphinx extension module names here, as strings. They can be
|
| 34 | |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
| 35 | |
# ones.
|
| 36 | |
extensions = [
|
| 37 | |
'openstackdocstheme',
|
| 38 | |
'reno.sphinxext',
|
| 39 | |
]
|
| 40 | |
|
| 41 | |
# Add any paths that contain templates here, relative to this directory.
|
| 42 | |
templates_path = ['_templates']
|
| 43 | |
|
| 44 | |
# The suffix of source filenames.
|
| 45 | |
source_suffix = '.rst'
|
| 46 | |
|
| 47 | |
# The encoding of source files.
|
| 48 | |
# source_encoding = 'utf-8-sig'
|
| 49 | |
|
| 50 | |
# The master toctree document.
|
| 51 | |
master_doc = 'index'
|
| 52 | |
|
| 53 | |
# General information about the project.
|
| 54 | |
project = u'cinder_tempest_plugin Release Notes'
|
| 55 | |
copyright = u'2017, OpenStack Developers'
|
| 56 | |
|
| 57 | |
# openstackdocstheme options
|
| 58 | |
repository_name = 'cinder_tempest_plugin/cinder_tempest_plugin'
|
| 59 | |
bug_project = 'cinder_tempest_plugin'
|
| 60 | |
bug_tag = ''
|
| 61 | |
|
| 62 | |
# The version info for the project you're documenting, acts as replacement for
|
| 63 | |
# |version| and |release|, also used in various other places throughout the
|
| 64 | |
# built documents.
|
| 65 | |
#
|
| 66 | |
# The short X.Y version.
|
| 67 | |
# The full version, including alpha/beta/rc tags.
|
| 68 | |
release = ''
|
| 69 | |
# The short X.Y version.
|
| 70 | |
version = ''
|
| 71 | |
|
| 72 | |
# The language for content autogenerated by Sphinx. Refer to documentation
|
| 73 | |
# for a list of supported languages.
|
| 74 | |
# language = None
|
| 75 | |
|
| 76 | |
# There are two options for replacing |today|: either, you set today to some
|
| 77 | |
# non-false value, then it is used:
|
| 78 | |
# today = ''
|
| 79 | |
# Else, today_fmt is used as the format for a strftime call.
|
| 80 | |
# today_fmt = '%B %d, %Y'
|
| 81 | |
|
| 82 | |
# List of patterns, relative to source directory, that match files and
|
| 83 | |
# directories to ignore when looking for source files.
|
| 84 | |
exclude_patterns = []
|
| 85 | |
|
| 86 | |
# The reST default role (used for this markup: `text`) to use for all
|
| 87 | |
# documents.
|
| 88 | |
# default_role = None
|
| 89 | |
|
| 90 | |
# If true, '()' will be appended to :func: etc. cross-reference text.
|
| 91 | |
# add_function_parentheses = True
|
| 92 | |
|
| 93 | |
# If true, the current module name will be prepended to all description
|
| 94 | |
# unit titles (such as .. function::).
|
| 95 | |
# add_module_names = True
|
| 96 | |
|
| 97 | |
# If true, sectionauthor and moduleauthor directives will be shown in the
|
| 98 | |
# output. They are ignored by default.
|
| 99 | |
# show_authors = False
|
| 100 | |
|
| 101 | |
# The name of the Pygments (syntax highlighting) style to use.
|
| 102 | |
pygments_style = 'sphinx'
|
| 103 | |
|
| 104 | |
# A list of ignored prefixes for module index sorting.
|
| 105 | |
# modindex_common_prefix = []
|
| 106 | |
|
| 107 | |
# If true, keep warnings as "system message" paragraphs in the built documents.
|
| 108 | |
# keep_warnings = False
|
| 109 | |
|
| 110 | |
|
| 111 | |
# -- Options for HTML output ----------------------------------------------
|
| 112 | |
|
| 113 | |
# The theme to use for HTML and HTML Help pages. See the documentation for
|
| 114 | |
# a list of builtin themes.
|
| 115 | |
html_theme = 'openstackdocs'
|
| 116 | |
|
| 117 | |
# Theme options are theme-specific and customize the look and feel of a theme
|
| 118 | |
# further. For a list of options available for each theme, see the
|
| 119 | |
# documentation.
|
| 120 | |
# html_theme_options = {}
|
| 121 | |
|
| 122 | |
# Add any paths that contain custom themes here, relative to this directory.
|
| 123 | |
# html_theme_path = []
|
| 124 | |
|
| 125 | |
# The name for this set of Sphinx documents. If None, it defaults to
|
| 126 | |
# "<project> v<release> documentation".
|
| 127 | |
# html_title = None
|
| 128 | |
|
| 129 | |
# A shorter title for the navigation bar. Default is the same as html_title.
|
| 130 | |
# html_short_title = None
|
| 131 | |
|
| 132 | |
# The name of an image file (relative to this directory) to place at the top
|
| 133 | |
# of the sidebar.
|
| 134 | |
# html_logo = None
|
| 135 | |
|
| 136 | |
# The name of an image file (within the static path) to use as favicon of the
|
| 137 | |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
| 138 | |
# pixels large.
|
| 139 | |
# html_favicon = None
|
| 140 | |
|
| 141 | |
# Add any paths that contain custom static files (such as style sheets) here,
|
| 142 | |
# relative to this directory. They are copied after the builtin static files,
|
| 143 | |
# so a file named "default.css" will overwrite the builtin "default.css".
|
| 144 | |
html_static_path = ['_static']
|
| 145 | |
|
| 146 | |
# Add any extra paths that contain custom files (such as robots.txt or
|
| 147 | |
# .htaccess) here, relative to this directory. These files are copied
|
| 148 | |
# directly to the root of the documentation.
|
| 149 | |
# html_extra_path = []
|
| 150 | |
|
| 151 | |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
| 152 | |
# using the given strftime format.
|
| 153 | |
# html_last_updated_fmt = '%b %d, %Y'
|
| 154 | |
|
| 155 | |
# If true, SmartyPants will be used to convert quotes and dashes to
|
| 156 | |
# typographically correct entities.
|
| 157 | |
# html_use_smartypants = True
|
| 158 | |
|
| 159 | |
# Custom sidebar templates, maps document names to template names.
|
| 160 | |
# html_sidebars = {}
|
| 161 | |
|
| 162 | |
# Additional templates that should be rendered to pages, maps page names to
|
| 163 | |
# template names.
|
| 164 | |
# html_additional_pages = {}
|
| 165 | |
|
| 166 | |
# If false, no module index is generated.
|
| 167 | |
# html_domain_indices = True
|
| 168 | |
|
| 169 | |
# If false, no index is generated.
|
| 170 | |
# html_use_index = True
|
| 171 | |
|
| 172 | |
# If true, the index is split into individual pages for each letter.
|
| 173 | |
# html_split_index = False
|
| 174 | |
|
| 175 | |
# If true, links to the reST sources are added to the pages.
|
| 176 | |
# html_show_sourcelink = True
|
| 177 | |
|
| 178 | |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
| 179 | |
# html_show_sphinx = True
|
| 180 | |
|
| 181 | |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
| 182 | |
# html_show_copyright = True
|
| 183 | |
|
| 184 | |
# If true, an OpenSearch description file will be output, and all pages will
|
| 185 | |
# contain a <link> tag referring to it. The value of this option must be the
|
| 186 | |
# base URL from which the finished HTML is served.
|
| 187 | |
# html_use_opensearch = ''
|
| 188 | |
|
| 189 | |
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
| 190 | |
# html_file_suffix = None
|
| 191 | |
|
| 192 | |
# Output file base name for HTML help builder.
|
| 193 | |
htmlhelp_basename = 'cinder_tempest_pluginReleaseNotesdoc'
|
| 194 | |
|
| 195 | |
|
| 196 | |
# -- Options for LaTeX output ---------------------------------------------
|
| 197 | |
|
| 198 | |
latex_elements = {
|
| 199 | |
# The paper size ('letterpaper' or 'a4paper').
|
| 200 | |
# 'papersize': 'letterpaper',
|
| 201 | |
|
| 202 | |
# The font size ('10pt', '11pt' or '12pt').
|
| 203 | |
# 'pointsize': '10pt',
|
| 204 | |
|
| 205 | |
# Additional stuff for the LaTeX preamble.
|
| 206 | |
# 'preamble': '',
|
| 207 | |
}
|
| 208 | |
|
| 209 | |
# Grouping the document tree into LaTeX files. List of tuples
|
| 210 | |
# (source start file, target name, title,
|
| 211 | |
# author, documentclass [howto, manual, or own class]).
|
| 212 | |
latex_documents = [
|
| 213 | |
('index', 'cinder_tempest_pluginReleaseNotes.tex',
|
| 214 | |
u'cinder_tempest_plugin Release Notes Documentation',
|
| 215 | |
u'OpenStack Foundation', 'manual'),
|
| 216 | |
]
|
| 217 | |
|
| 218 | |
# The name of an image file (relative to this directory) to place at the top of
|
| 219 | |
# the title page.
|
| 220 | |
# latex_logo = None
|
| 221 | |
|
| 222 | |
# For "manual" documents, if this is true, then toplevel headings are parts,
|
| 223 | |
# not chapters.
|
| 224 | |
# latex_use_parts = False
|
| 225 | |
|
| 226 | |
# If true, show page references after internal links.
|
| 227 | |
# latex_show_pagerefs = False
|
| 228 | |
|
| 229 | |
# If true, show URL addresses after external links.
|
| 230 | |
# latex_show_urls = False
|
| 231 | |
|
| 232 | |
# Documents to append as an appendix to all manuals.
|
| 233 | |
# latex_appendices = []
|
| 234 | |
|
| 235 | |
# If false, no module index is generated.
|
| 236 | |
# latex_domain_indices = True
|
| 237 | |
|
| 238 | |
|
| 239 | |
# -- Options for manual page output ---------------------------------------
|
| 240 | |
|
| 241 | |
# One entry per manual page. List of tuples
|
| 242 | |
# (source start file, name, description, authors, manual section).
|
| 243 | |
man_pages = [
|
| 244 | |
('index', 'cinder_tempest_pluginrereleasenotes',
|
| 245 | |
u'cinder_tempest_plugin Release Notes Documentation',
|
| 246 | |
[u'OpenStack Foundation'], 1)
|
| 247 | |
]
|
| 248 | |
|
| 249 | |
# If true, show URL addresses after external links.
|
| 250 | |
# man_show_urls = False
|
| 251 | |
|
| 252 | |
|
| 253 | |
# -- Options for Texinfo output -------------------------------------------
|
| 254 | |
|
| 255 | |
# Grouping the document tree into Texinfo files. List of tuples
|
| 256 | |
# (source start file, target name, title, author,
|
| 257 | |
# dir menu entry, description, category)
|
| 258 | |
texinfo_documents = [
|
| 259 | |
('index', 'cinder_tempest_plugin ReleaseNotes',
|
| 260 | |
u'cinder_tempest_plugin Release Notes Documentation',
|
| 261 | |
u'OpenStack Foundation', 'cinder_tempest_pluginReleaseNotes',
|
| 262 | |
'One line description of project.',
|
| 263 | |
'Miscellaneous'),
|
| 264 | |
]
|
| 265 | |
|
| 266 | |
# Documents to append as an appendix to all manuals.
|
| 267 | |
# texinfo_appendices = []
|
| 268 | |
|
| 269 | |
# If false, no module index is generated.
|
| 270 | |
# texinfo_domain_indices = True
|
| 271 | |
|
| 272 | |
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
| 273 | |
# texinfo_show_urls = 'footnote'
|
| 274 | |
|
| 275 | |
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
| 276 | |
# texinfo_no_detailmenu = False
|
| 277 | |
|
| 278 | |
# -- Options for Internationalization output ------------------------------
|
| 279 | |
locale_dirs = ['locale/']
|