blob: 3ec25ea1140c2350eeac7e1b009534195b4013c5 [file] [log] [blame]
Sean Dagueb56052b2013-05-21 17:57:41 -04001# -*- coding: utf-8 -*-
2#
3# Tempest documentation build configuration file, created by
4# sphinx-quickstart on Tue May 21 17:43:32 2013.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
Matthew Treinish6d5c0522013-09-11 15:50:30 +000014import sys
15import os
Matthew Treinish13ed69f2015-08-10 11:51:54 -040016import subprocess
17
18# Build a tempest sample config file:
19def build_sample_config(app):
20 root_dir = os.path.dirname(
21 os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
22 subprocess.call(["oslo-config-generator", "--config-file",
23 "tools/config/config-generator.tempest.conf",
24 "--output-file", "doc/source/_static/tempest.conf"],
25 cwd=root_dir)
26
27def setup(app):
28 app.connect('builder-inited', build_sample_config)
Sean Dagueb56052b2013-05-21 17:57:41 -040029
30# If extensions (or modules to document with autodoc) are in another directory,
31# add these directories to sys.path here. If the directory is relative to the
32# documentation root, use os.path.abspath to make it absolute, like shown here.
33#sys.path.insert(0, os.path.abspath('.'))
34
35# -- General configuration -----------------------------------------------------
36
37# If your documentation needs a minimal Sphinx version, state it here.
38#needs_sphinx = '1.0'
39
40# Add any Sphinx extension module names here, as strings. They can be extensions
41# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Matthew Treinish6d5c0522013-09-11 15:50:30 +000042extensions = ['sphinx.ext.autodoc',
Matthew Treinish6d5c0522013-09-11 15:50:30 +000043 'sphinx.ext.todo',
44 'sphinx.ext.viewcode',
Dirk Mueller82ba4282014-02-13 14:27:54 +010045 'oslosphinx'
Matthew Treinish6d5c0522013-09-11 15:50:30 +000046 ]
47
48todo_include_todos = True
Sean Dagueb56052b2013-05-21 17:57:41 -040049
50# Add any paths that contain templates here, relative to this directory.
51templates_path = ['_templates']
52
53# The suffix of source filenames.
54source_suffix = '.rst'
55
56# The encoding of source files.
57#source_encoding = 'utf-8-sig'
58
59# The master toctree document.
60master_doc = 'index'
61
62# General information about the project.
63project = u'Tempest'
Matthew Treinish6d5c0522013-09-11 15:50:30 +000064copyright = u'2013, OpenStack QA Team'
Sean Dagueb56052b2013-05-21 17:57:41 -040065
Sean Dagueb56052b2013-05-21 17:57:41 -040066# The language for content autogenerated by Sphinx. Refer to documentation
67# for a list of supported languages.
68#language = None
69
70# There are two options for replacing |today|: either, you set today to some
71# non-false value, then it is used:
72#today = ''
73# Else, today_fmt is used as the format for a strftime call.
74#today_fmt = '%B %d, %Y'
75
76# List of patterns, relative to source directory, that match files and
77# directories to ignore when looking for source files.
78exclude_patterns = ['_build']
79
80# The reST default role (used for this markup: `text`) to use for all documents.
81#default_role = None
82
83# If true, '()' will be appended to :func: etc. cross-reference text.
84#add_function_parentheses = True
85
86# If true, the current module name will be prepended to all description
87# unit titles (such as .. function::).
Matthew Treinish6d5c0522013-09-11 15:50:30 +000088add_module_names = False
Sean Dagueb56052b2013-05-21 17:57:41 -040089
90# If true, sectionauthor and moduleauthor directives will be shown in the
91# output. They are ignored by default.
Matthew Treinish6d5c0522013-09-11 15:50:30 +000092show_authors = False
Sean Dagueb56052b2013-05-21 17:57:41 -040093
94# The name of the Pygments (syntax highlighting) style to use.
95pygments_style = 'sphinx'
96
97# A list of ignored prefixes for module index sorting.
Matthew Treinish6d5c0522013-09-11 15:50:30 +000098modindex_common_prefix = ['tempest.']
Sean Dagueb56052b2013-05-21 17:57:41 -040099
100
101# -- Options for HTML output ---------------------------------------------------
102
103# The theme to use for HTML and HTML Help pages. See the documentation for
104# a list of builtin themes.
Sean Dague7679b482013-05-24 08:49:44 -0400105html_theme = 'nature'
Sean Dagueb56052b2013-05-21 17:57:41 -0400106
107# Theme options are theme-specific and customize the look and feel of a theme
108# further. For a list of options available for each theme, see the
109# documentation.
110#html_theme_options = {}
111
112# Add any paths that contain custom themes here, relative to this directory.
113#html_theme_path = []
114
115# The name for this set of Sphinx documents. If None, it defaults to
116# "<project> v<release> documentation".
117#html_title = None
118
119# A shorter title for the navigation bar. Default is the same as html_title.
120#html_short_title = None
121
122# The name of an image file (relative to this directory) to place at the top
123# of the sidebar.
124#html_logo = None
125
126# The name of an image file (within the static path) to use as favicon of the
127# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
128# pixels large.
129#html_favicon = None
130
131# Add any paths that contain custom static files (such as style sheets) here,
132# relative to this directory. They are copied after the builtin static files,
133# so a file named "default.css" will overwrite the builtin "default.css".
134html_static_path = ['_static']
135
136# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
137# using the given strftime format.
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000138git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
139html_last_updated_fmt = os.popen(git_cmd).read()
Sean Dagueb56052b2013-05-21 17:57:41 -0400140
141# If true, SmartyPants will be used to convert quotes and dashes to
142# typographically correct entities.
143#html_use_smartypants = True
144
145# Custom sidebar templates, maps document names to template names.
146#html_sidebars = {}
147
148# Additional templates that should be rendered to pages, maps page names to
149# template names.
150#html_additional_pages = {}
151
152# If false, no module index is generated.
Michael Chapman4410ca12013-06-25 13:05:10 +1000153html_domain_indices = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400154
155# If false, no index is generated.
Michael Chapman4410ca12013-06-25 13:05:10 +1000156html_use_index = False
Sean Dagueb56052b2013-05-21 17:57:41 -0400157
158# If true, the index is split into individual pages for each letter.
159#html_split_index = False
160
161# If true, links to the reST sources are added to the pages.
162#html_show_sourcelink = True
163
164# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
165#html_show_sphinx = True
166
167# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
168#html_show_copyright = True
169
170# If true, an OpenSearch description file will be output, and all pages will
171# contain a <link> tag referring to it. The value of this option must be the
172# base URL from which the finished HTML is served.
173#html_use_opensearch = ''
174
175# This is the file name suffix for HTML files (e.g. ".xhtml").
176#html_file_suffix = None
177
178# Output file base name for HTML help builder.
179htmlhelp_basename = 'Tempestdoc'
180
181
182# -- Options for LaTeX output --------------------------------------------------
183
184latex_elements = {
185# The paper size ('letterpaper' or 'a4paper').
186#'papersize': 'letterpaper',
187
188# The font size ('10pt', '11pt' or '12pt').
189#'pointsize': '10pt',
190
191# Additional stuff for the LaTeX preamble.
192#'preamble': '',
193}
194
195# Grouping the document tree into LaTeX files. List of tuples
196# (source start file, target name, title, author, documentclass [howto/manual]).
197latex_documents = [
198 ('index', 'Tempest.tex', u'Tempest Documentation',
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000199 u'OpenStack QA Team', 'manual'),
Sean Dagueb56052b2013-05-21 17:57:41 -0400200]
201
202# The name of an image file (relative to this directory) to place at the top of
203# the title page.
204#latex_logo = None
205
206# For "manual" documents, if this is true, then toplevel headings are parts,
207# not chapters.
208#latex_use_parts = False
209
210# If true, show page references after internal links.
211#latex_show_pagerefs = False
212
213# If true, show URL addresses after external links.
214#latex_show_urls = False
215
216# Documents to append as an appendix to all manuals.
217#latex_appendices = []
218
219# If false, no module index is generated.
220#latex_domain_indices = True
221
222
223# -- Options for manual page output --------------------------------------------
224
225# One entry per manual page. List of tuples
226# (source start file, name, description, authors, manual section).
227man_pages = [
228 ('index', 'tempest', u'Tempest Documentation',
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000229 [u'OpenStack QA Team'], 1)
Sean Dagueb56052b2013-05-21 17:57:41 -0400230]
231
232# If true, show URL addresses after external links.
233#man_show_urls = False
234
235
236# -- Options for Texinfo output ------------------------------------------------
237
238# Grouping the document tree into Texinfo files. List of tuples
239# (source start file, target name, title, author,
240# dir menu entry, description, category)
241texinfo_documents = [
242 ('index', 'Tempest', u'Tempest Documentation',
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000243 u'OpenStack QA Team', 'Tempest', 'One line description of project.',
Sean Dagueb56052b2013-05-21 17:57:41 -0400244 'Miscellaneous'),
245]
246
247# Documents to append as an appendix to all manuals.
248#texinfo_appendices = []
249
250# If false, no module index is generated.
251#texinfo_domain_indices = True
252
253# How to display URL addresses: 'footnote', 'no', or 'inline'.
254#texinfo_show_urls = 'footnote'
255
256
257# -- Options for Epub output ---------------------------------------------------
258
259# Bibliographic Dublin Core info.
260epub_title = u'Tempest'
261epub_author = u'Sean Dague'
Matthew Treinish6d5c0522013-09-11 15:50:30 +0000262epub_publisher = u'OpenStack QA Team'
263epub_copyright = u'2013, OpenStack QA Team'
Sean Dagueb56052b2013-05-21 17:57:41 -0400264
265# The language of the text. It defaults to the language option
266# or en if the language is not set.
267#epub_language = ''
268
269# The scheme of the identifier. Typical schemes are ISBN or URL.
270#epub_scheme = ''
271
272# The unique identifier of the text. This can be a ISBN number
273# or the project homepage.
274#epub_identifier = ''
275
276# A unique identification for the text.
277#epub_uid = ''
278
279# A tuple containing the cover image and cover page html template filenames.
280#epub_cover = ()
281
282# HTML files that should be inserted before the pages created by sphinx.
283# The format is a list of tuples containing the path and title.
284#epub_pre_files = []
285
286# HTML files shat should be inserted after the pages created by sphinx.
287# The format is a list of tuples containing the path and title.
288#epub_post_files = []
289
290# A list of files that should not be packed into the epub file.
291#epub_exclude_files = []
292
293# The depth of the table of contents in toc.ncx.
294#epub_tocdepth = 3
295
296# Allow duplicate toc entries.
297#epub_tocdup = True