blob: 71c7697bb200a24409b09587ade4386215e37952 [file] [log] [blame]
James E. Blaircdd00072012-06-08 19:17:28 -07001# -*- coding: utf-8 -*-
2#
3# Zuul documentation build configuration file, created by
4# sphinx-quickstart on Fri Jun 8 14:44:26 2012.
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
14import sys, os
15
16# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.
Paul Belanger3e16b552013-03-27 10:52:29 -040019sys.path.insert(0, os.path.abspath('../..'))
James E. Blaircdd00072012-06-08 19:17:28 -070020
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Monty Taylor82dfd412016-07-29 12:01:28 -070028extensions = [
29 'sphinx.ext.autodoc',
30 'sphinxcontrib.blockdiag',
James E. Blair157df022017-06-23 20:24:11 +010031 'sphinxcontrib.programoutput',
32 'oslosphinx'
Monty Taylor82dfd412016-07-29 12:01:28 -070033]
Antoine Musso28db2af2013-10-05 16:12:03 +020034#extensions = ['sphinx.ext.intersphinx']
35#intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}
James E. Blaircdd00072012-06-08 19:17:28 -070036
37# Add any paths that contain templates here, relative to this directory.
38templates_path = ['_templates']
39
40# The suffix of source filenames.
41source_suffix = '.rst'
42
43# The encoding of source files.
44#source_encoding = 'utf-8-sig'
45
46# The master toctree document.
47master_doc = 'index'
48
49# General information about the project.
50project = u'Zuul'
51copyright = u'2012, OpenStack'
52
James E. Blaircdd00072012-06-08 19:17:28 -070053# The language for content autogenerated by Sphinx. Refer to documentation
54# for a list of supported languages.
55#language = None
56
57# There are two options for replacing |today|: either, you set today to some
58# non-false value, then it is used:
59#today = ''
60# Else, today_fmt is used as the format for a strftime call.
61#today_fmt = '%B %d, %Y'
62
63# List of patterns, relative to source directory, that match files and
64# directories to ignore when looking for source files.
65exclude_patterns = []
66
67# The reST default role (used for this markup: `text`) to use for all documents.
68#default_role = None
69
70# If true, '()' will be appended to :func: etc. cross-reference text.
71#add_function_parentheses = True
72
73# If true, the current module name will be prepended to all description
74# unit titles (such as .. function::).
75#add_module_names = True
76
77# If true, sectionauthor and moduleauthor directives will be shown in the
78# output. They are ignored by default.
79#show_authors = False
80
81# The name of the Pygments (syntax highlighting) style to use.
82pygments_style = 'sphinx'
83
84# A list of ignored prefixes for module index sorting.
85#modindex_common_prefix = []
86
87
88# -- Options for HTML output ---------------------------------------------------
89
90# The theme to use for HTML and HTML Help pages. See the documentation for
91# a list of builtin themes.
92html_theme = 'default'
93
94# Theme options are theme-specific and customize the look and feel of a theme
95# further. For a list of options available for each theme, see the
96# documentation.
97#html_theme_options = {}
98
99# Add any paths that contain custom themes here, relative to this directory.
100#html_theme_path = []
101
102# The name for this set of Sphinx documents. If None, it defaults to
103# "<project> v<release> documentation".
104#html_title = None
105
106# A shorter title for the navigation bar. Default is the same as html_title.
107#html_short_title = None
108
109# The name of an image file (relative to this directory) to place at the top
110# of the sidebar.
111#html_logo = None
112
113# The name of an image file (within the static path) to use as favicon of the
114# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
115# pixels large.
116#html_favicon = None
117
118# Add any paths that contain custom static files (such as style sheets) here,
119# relative to this directory. They are copied after the builtin static files,
120# so a file named "default.css" will overwrite the builtin "default.css".
Antoine Mussod06f2a62012-11-16 17:40:58 +0100121#html_static_path = ['_static']
James E. Blaircdd00072012-06-08 19:17:28 -0700122
123# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
124# using the given strftime format.
125#html_last_updated_fmt = '%b %d, %Y'
126
127# If true, SmartyPants will be used to convert quotes and dashes to
128# typographically correct entities.
129#html_use_smartypants = True
130
131# Custom sidebar templates, maps document names to template names.
132#html_sidebars = {}
133
134# Additional templates that should be rendered to pages, maps page names to
135# template names.
136#html_additional_pages = {}
137
138# If false, no module index is generated.
139#html_domain_indices = True
140
141# If false, no index is generated.
142#html_use_index = True
143
144# If true, the index is split into individual pages for each letter.
145#html_split_index = False
146
147# If true, links to the reST sources are added to the pages.
148#html_show_sourcelink = True
149
150# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
151#html_show_sphinx = True
152
153# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
154#html_show_copyright = True
155
156# If true, an OpenSearch description file will be output, and all pages will
157# contain a <link> tag referring to it. The value of this option must be the
158# base URL from which the finished HTML is served.
159#html_use_opensearch = ''
160
161# This is the file name suffix for HTML files (e.g. ".xhtml").
162#html_file_suffix = None
163
164# Output file base name for HTML help builder.
165htmlhelp_basename = 'Zuuldoc'
166
167
168# -- Options for LaTeX output --------------------------------------------------
169
170latex_elements = {
171# The paper size ('letterpaper' or 'a4paper').
172#'papersize': 'letterpaper',
173
174# The font size ('10pt', '11pt' or '12pt').
175#'pointsize': '10pt',
176
177# Additional stuff for the LaTeX preamble.
178#'preamble': '',
179}
180
181# Grouping the document tree into LaTeX files. List of tuples
182# (source start file, target name, title, author, documentclass [howto/manual]).
183latex_documents = [
184 ('index', 'Zuul.tex', u'Zuul Documentation',
185 u'OpenStack', 'manual'),
186]
187
188# The name of an image file (relative to this directory) to place at the top of
189# the title page.
190#latex_logo = None
191
192# For "manual" documents, if this is true, then toplevel headings are parts,
193# not chapters.
194#latex_use_parts = False
195
196# If true, show page references after internal links.
197#latex_show_pagerefs = False
198
199# If true, show URL addresses after external links.
200#latex_show_urls = False
201
202# Documents to append as an appendix to all manuals.
203#latex_appendices = []
204
205# If false, no module index is generated.
206#latex_domain_indices = True
207
208
209# -- Options for manual page output --------------------------------------------
210
211# One entry per manual page. List of tuples
212# (source start file, name, description, authors, manual section).
213man_pages = [
Antoine Mussod5dcfd72013-05-15 22:13:17 +0200214 ('index', 'zuul-server', u'Zuul Documentation',
James E. Blaircdd00072012-06-08 19:17:28 -0700215 [u'OpenStack'], 1)
216]
217
218# If true, show URL addresses after external links.
219#man_show_urls = False
220
221
222# -- Options for Texinfo output ------------------------------------------------
223
224# Grouping the document tree into Texinfo files. List of tuples
225# (source start file, target name, title, author,
226# dir menu entry, description, category)
227texinfo_documents = [
228 ('index', 'Zuul', u'Zuul Documentation',
229 u'OpenStack', 'Zuul', 'One line description of project.',
230 'Miscellaneous'),
231]
232
233# Documents to append as an appendix to all manuals.
234#texinfo_appendices = []
235
236# If false, no module index is generated.
237#texinfo_domain_indices = True
238
239# How to display URL addresses: 'footnote', 'no', or 'inline'.
240#texinfo_show_urls = 'footnote'