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