blob: f11d96a8894a08b72781cb41051c6bdd18befb17 [file] [log] [blame]
yuhui_inspurcd420fb2017-04-11 01:46:48 -07001# 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
Sean Dagueb56052b2013-05-21 17:57:41 -040014# Tempest documentation build configuration file, created by
15# sphinx-quickstart on Tue May 21 17:43:32 2013.
16#
17# This file is execfile()d with the current directory set to its containing dir.
18#
19# Note that not all possible configuration values are present in this
20# autogenerated file.
21#
22# All configuration values have a default; values that are commented out
23# serve to show the default.
24
Matthew Treinish6d5c0522013-09-11 15:50:30 +000025import sys
26import os
Matthew Treinish13ed69f2015-08-10 11:51:54 -040027import subprocess
Thomas Bechtold89d56172016-08-30 18:57:09 +020028import warnings
Matthew Treinish13ed69f2015-08-10 11:51:54 -040029
Masayuki Igawad2a657d2017-05-08 15:25:56 -040030import openstackdocstheme
31
Matthew Treinishfc463262016-06-29 10:39:02 -040032# Build the plugin registry
33def build_plugin_registry(app):
34 root_dir = os.path.dirname(
35 os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
36 subprocess.call(['tools/generate-tempest-plugins-list.sh'], cwd=root_dir)
37
38def setup(app):
39 app.connect('builder-inited', build_plugin_registry)
40
41
42
Sean Dagueb56052b2013-05-21 17:57:41 -040043# If extensions (or modules to document with autodoc) are in another directory,
44# add these directories to sys.path here. If the directory is relative to the
45# documentation root, use os.path.abspath to make it absolute, like shown here.
46#sys.path.insert(0, os.path.abspath('.'))
47
48# -- General configuration -----------------------------------------------------
49
50# If your documentation needs a minimal Sphinx version, state it here.
51#needs_sphinx = '1.0'
52
53# Add any Sphinx extension module names here, as strings. They can be extensions
54# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Matthew Treinish6d5c0522013-09-11 15:50:30 +000055extensions = ['sphinx.ext.autodoc',
Matthew Treinish6d5c0522013-09-11 15:50:30 +000056 'sphinx.ext.todo',
57 'sphinx.ext.viewcode',
Matthew Treinish1719dfe2015-08-24 17:55:09 -040058 'oslosphinx',
59 'oslo_config.sphinxconfiggen',
Matthew Treinish6d5c0522013-09-11 15:50:30 +000060 ]
61
Matthew Treinishbdef1c72016-06-21 18:06:49 -040062config_generator_config_file = '../../tempest/cmd/config-generator.tempest.conf'
Matthew Treinish1719dfe2015-08-24 17:55:09 -040063sample_config_basename = '_static/tempest'
64
Matthew Treinish6d5c0522013-09-11 15:50:30 +000065todo_include_todos = True
Sean Dagueb56052b2013-05-21 17:57:41 -040066
67# Add any paths that contain templates here, relative to this directory.
68templates_path = ['_templates']
69
70# The suffix of source filenames.
71source_suffix = '.rst'
72
73# The encoding of source files.
74#source_encoding = 'utf-8-sig'
75
76# The master toctree document.
77master_doc = 'index'
78
79# General information about the project.
80project = u'Tempest'
Matthew Treinish6d5c0522013-09-11 15:50:30 +000081copyright = u'2013, OpenStack QA Team'
Sean Dagueb56052b2013-05-21 17:57:41 -040082
Sean Dagueb56052b2013-05-21 17:57:41 -040083# The language for content autogenerated by Sphinx. Refer to documentation
84# for a list of supported languages.
85#language = None
86
87# There are two options for replacing |today|: either, you set today to some
88# non-false value, then it is used:
89#today = ''
90# Else, today_fmt is used as the format for a strftime call.
91#today_fmt = '%B %d, %Y'
92
93# List of patterns, relative to source directory, that match files and
94# directories to ignore when looking for source files.
95exclude_patterns = ['_build']
96
97# The reST default role (used for this markup: `text`) to use for all documents.
98#default_role = None
99
100# If true, '()' will be appended to :func: etc. cross-reference text.
101#add_function_parentheses = True
102
103# If true, the current module name will be prepended to all description
104# unit titles (such as .. function::).
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000105add_module_names = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400106
107# If true, sectionauthor and moduleauthor directives will be shown in the
108# output. They are ignored by default.
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000109show_authors = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400110
111# The name of the Pygments (syntax highlighting) style to use.
112pygments_style = 'sphinx'
113
114# A list of ignored prefixes for module index sorting.
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000115modindex_common_prefix = ['tempest.']
Sean Dagueb56052b2013-05-21 17:57:41 -0400116
117
118# -- Options for HTML output ---------------------------------------------------
119
120# The theme to use for HTML and HTML Help pages. See the documentation for
121# a list of builtin themes.
Masayuki Igawad2a657d2017-05-08 15:25:56 -0400122html_theme = 'openstackdocs'
Sean Dagueb56052b2013-05-21 17:57:41 -0400123
124# Theme options are theme-specific and customize the look and feel of a theme
125# further. For a list of options available for each theme, see the
126# documentation.
127#html_theme_options = {}
128
129# Add any paths that contain custom themes here, relative to this directory.
Masayuki Igawad2a657d2017-05-08 15:25:56 -0400130html_theme_path = [openstackdocstheme.get_html_theme_path()]
Sean Dagueb56052b2013-05-21 17:57:41 -0400131
132# The name for this set of Sphinx documents. If None, it defaults to
133# "<project> v<release> documentation".
134#html_title = None
135
136# A shorter title for the navigation bar. Default is the same as html_title.
137#html_short_title = None
138
139# The name of an image file (relative to this directory) to place at the top
140# of the sidebar.
141#html_logo = None
142
143# The name of an image file (within the static path) to use as favicon of the
144# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
145# pixels large.
146#html_favicon = None
147
148# Add any paths that contain custom static files (such as style sheets) here,
149# relative to this directory. They are copied after the builtin static files,
150# so a file named "default.css" will overwrite the builtin "default.css".
151html_static_path = ['_static']
152
153# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154# using the given strftime format.
Harshada Mangesh Kakadd11d5ee2015-12-31 01:38:46 -0800155git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
156 "-n1"]
Thomas Bechtold89d56172016-08-30 18:57:09 +0200157try:
Stephen Finucaned1148042017-03-22 12:35:10 +0000158 html_last_updated_fmt = str(
159 subprocess.Popen(git_cmd, stdout=subprocess.PIPE).communicate()[0])
Thomas Bechtold89d56172016-08-30 18:57:09 +0200160except Exception:
161 warnings.warn('Cannot get last updated time from git repository. '
162 'Not setting "html_last_updated_fmt".')
Sean Dagueb56052b2013-05-21 17:57:41 -0400163
164# If true, SmartyPants will be used to convert quotes and dashes to
165# typographically correct entities.
Masayuki Igawa44ca9ed2016-06-10 09:25:48 +0900166html_use_smartypants = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400167
168# Custom sidebar templates, maps document names to template names.
169#html_sidebars = {}
170
171# Additional templates that should be rendered to pages, maps page names to
172# template names.
173#html_additional_pages = {}
174
175# If false, no module index is generated.
Michael Chapman4410ca12013-06-25 13:05:10 +1000176html_domain_indices = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400177
178# If false, no index is generated.
Michael Chapman4410ca12013-06-25 13:05:10 +1000179html_use_index = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400180
181# If true, the index is split into individual pages for each letter.
182#html_split_index = False
183
184# If true, links to the reST sources are added to the pages.
185#html_show_sourcelink = True
186
187# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
188#html_show_sphinx = True
189
190# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
191#html_show_copyright = True
192
193# If true, an OpenSearch description file will be output, and all pages will
194# contain a <link> tag referring to it. The value of this option must be the
195# base URL from which the finished HTML is served.
196#html_use_opensearch = ''
197
198# This is the file name suffix for HTML files (e.g. ".xhtml").
199#html_file_suffix = None
Stephen Finucaned1148042017-03-22 12:35:10 +0000200
201# A list of warning types to suppress arbitrary warning messages.
202suppress_warnings = ['image.nonlocal_uri']