Debian Codegraph @

releasenotes/source/conf.py

raw
1 # -*- coding: utf-8 -*-
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License"); you may
4 # not use this file except in compliance with the License. You may obtain
5 # a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 # License for the specific language governing permissions and limitations
13 # under the License.
14 #
15 # ironic-ui documentation build configuration file, created by
16 # sphinx-quickstart on Tue Aug 16 16:29:30 2016.
17 #
18 # This file is execfile()d with the current directory set to its
19 # containing dir.
20 #
21 # Note that not all possible configuration values are present in this
22 # autogenerated file.
23 #
24 # All configuration values have a default; values that are commented out
25 # serve to show the default.
26
27 # If extensions (or modules to document with autodoc) are in another directory,
28 # add these directories to sys.path here. If the directory is relative to the
29 # documentation root, use os.path.abspath to make it absolute, like shown here.
30 #
31 # import os
32 # import sys
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 #
39 # needs_sphinx = '1.0'
40
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43 # ones.
44 extensions = [
45 'openstackdocstheme',
46 'reno.sphinxext',
47 ]
48 # Add any paths that contain templates here, relative to this directory.
49 # templates_path = ['_templates']
50
51 # The suffix(es) of source filenames.
52 # You can specify multiple suffix as a list of string:
53 #
54 # source_suffix = ['.rst', '.md']
55 source_suffix = '.rst'
56
57 # The encoding of source files.
58 #
59 # source_encoding = 'utf-8-sig'
60
61 # The master toctree document.
62 master_doc = 'index'
63
64 # General information about the project.
65 project = 'ironic-ui'
66 copyright = '2016, OpenStack'
67 author = 'OpenStack'
68
69 # Release notes are version independent
70 # The short X.Y version.
71 version = ''
72 # The full version, including alpha/beta/rc tags.
73 release = ''
74
75 # The language for content autogenerated by Sphinx. Refer to documentation
76 # for a list of supported languages.
77 #
78 # This is also used if you do content translation via gettext catalogs.
79 # Usually you set "language" from the command line for these cases.
80 # language = None
81
82 # There are two options for replacing |today|: either, you set today to some
83 # non-false value, then it is used:
84 #
85 # today = ''
86 #
87 # Else, today_fmt is used as the format for a strftime call.
88 #
89 # today_fmt = '%B %d, %Y'
90
91 # List of patterns, relative to source directory, that match files and
92 # directories to ignore when looking for source files.
93 # This patterns also effect to html_static_path and html_extra_path
94 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
95
96 # The reST default role (used for this markup: `text`) to use for all
97 # documents.
98 #
99 # default_role = None
100
101 # If true, '()' will be appended to :func: etc. cross-reference text.
102 #
103 # add_function_parentheses = True
104
105 # If true, the current module name will be prepended to all description
106 # unit titles (such as .. function::).
107 #
108 # add_module_names = True
109
110 # If true, sectionauthor and moduleauthor directives will be shown in the
111 # output. They are ignored by default.
112 #
113 # show_authors = False
114
115 # The name of the Pygments (syntax highlighting) style to use.
116 pygments_style = 'native'
117
118 # A list of ignored prefixes for module index sorting.
119 # modindex_common_prefix = []
120
121 # If true, keep warnings as "system message" paragraphs in the built documents.
122 # keep_warnings = False
123
124 # If true, `todo` and `todoList` produce output, else they produce nothing.
125 todo_include_todos = False
126
127
128 # -- Options for HTML output ----------------------------------------------
129
130 # The theme to use for HTML and HTML Help pages. See the documentation for
131 # a list of builtin themes.
132 #
133 html_theme = 'openstackdocs'
134
135 # openstackdocstheme options
136 openstackdocs_repo_name = 'openstack/ironic-ui'
137 openstackdocs_use_storyboard = False
138 openstackdocs_auto_name = False
139
140 # Theme options are theme-specific and customize the look and feel of a theme
141 # further. For a list of options available for each theme, see the
142 # documentation.
143 #
144 # html_theme_options = {}
145
146 # Add any paths that contain custom themes here, relative to this directory.
147 # html_theme_path = []
148
149 # The name for this set of Sphinx documents.
150 # "<project> v<release> documentation" by default.
151 #
152 # html_title = u'ironic-ui v2.0.0'
153
154 # A shorter title for the navigation bar. Default is the same as html_title.
155 #
156 # html_short_title = None
157
158 # The name of an image file (relative to this directory) to place at the top
159 # of the sidebar.
160 #
161 # html_logo = None
162
163 # The name of an image file (relative to this directory) to use as a favicon of
164 # the docs. This file should be a Windows icon file (.ico) being 16x16 or
165 # 32x32 pixels large.
166 #
167 # html_favicon = None
168
169 # Add any paths that contain custom static files (such as style sheets) here,
170 # relative to this directory. They are copied after the builtin static files,
171 # so a file named "default.css" will overwrite the builtin "default.css".
172 # html_static_path = ['_static']
173
174 # Add any extra paths that contain custom files (such as robots.txt or
175 # .htaccess) here, relative to this directory. These files are copied
176 # directly to the root of the documentation.
177 #
178 # html_extra_path = []
179
180 # If true, SmartyPants will be used to convert quotes and dashes to
181 # typographically correct entities.
182 #
183 # html_use_smartypants = True
184
185 # Custom sidebar templates, maps document names to template names.
186 #
187 # html_sidebars = {}
188
189 # Additional templates that should be rendered to pages, maps page names to
190 # template names.
191 #
192 # html_additional_pages = {}
193
194 # If false, no module index is generated.
195 #
196 # html_domain_indices = True
197
198 # If false, no index is generated.
199 #
200 # html_use_index = True
201
202 # If true, the index is split into individual pages for each letter.
203 #
204 # html_split_index = False
205
206 # If true, links to the reST sources are added to the pages.
207 #
208 # html_show_sourcelink = True
209
210 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
211 #
212 # html_show_sphinx = True
213
214 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
215 #
216 # html_show_copyright = True
217
218 # If true, an OpenSearch description file will be output, and all pages will
219 # contain a <link> tag referring to it. The value of this option must be the
220 # base URL from which the finished HTML is served.
221 #
222 # html_use_opensearch = ''
223
224 # This is the file name suffix for HTML files (e.g. ".xhtml").
225 # html_file_suffix = None
226
227 # Language to be used for generating the HTML full-text search index.
228 # Sphinx supports the following languages:
229 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
230 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
231 #
232 # html_search_language = 'en'
233
234 # A dictionary with options for the search language support, empty by default.
235 # 'ja' uses this config value.
236 # 'zh' user can custom change `jieba` dictionary path.
237 #
238 # html_search_options = {'type': 'default'}
239
240 # The name of a javascript file (relative to the configuration directory) that
241 # implements a search results scorer. If empty, the default will be used.
242 #
243 # html_search_scorer = 'scorer.js'
244
245 # Output file base name for HTML help builder.
246 htmlhelp_basename = 'ironic-uidoc'
247
248 # -- Options for LaTeX output ---------------------------------------------
249
250 latex_elements = {
251 # The paper size ('letterpaper' or 'a4paper').
252 #
253 # 'papersize': 'letterpaper',
254
255 # The font size ('10pt', '11pt' or '12pt').
256 #
257 # 'pointsize': '10pt',
258
259 # Additional stuff for the LaTeX preamble.
260 #
261 # 'preamble': '',
262
263 # Latex figure (float) alignment
264 #
265 # 'figure_align': 'htbp',
266 }
267
268 # Grouping the document tree into LaTeX files. List of tuples
269 # (source start file, target name, title,
270 # author, documentclass [howto, manual, or own class]).
271 latex_documents = [
272 (master_doc, 'ironic-ui.tex', 'ironic-ui Documentation',
273 'OpenStack', 'manual'),
274 ]
275
276 # The name of an image file (relative to this directory) to place at the top of
277 # the title page.
278 #
279 # latex_logo = None
280
281 # For "manual" documents, if this is true, then toplevel headings are parts,
282 # not chapters.
283 #
284 # latex_use_parts = False
285
286 # If true, show page references after internal links.
287 #
288 # latex_show_pagerefs = False
289
290 # If true, show URL addresses after external links.
291 #
292 # latex_show_urls = False
293
294 # Documents to append as an appendix to all manuals.
295 #
296 # latex_appendices = []
297
298 # It false, will not define \strong, \code, itleref, \crossref ... but only
299 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
300 # packages.
301 #
302 # latex_keep_old_macro_names = True
303
304 # If false, no module index is generated.
305 #
306 # latex_domain_indices = True
307
308
309 # -- Options for manual page output ---------------------------------------
310
311 # One entry per manual page. List of tuples
312 # (source start file, name, description, authors, manual section).
313 man_pages = [
314 (master_doc, 'ironic-ui', 'ironic-ui Documentation',
315 [author], 1)
316 ]
317
318 # If true, show URL addresses after external links.
319 #
320 # man_show_urls = False
321
322
323 # -- Options for Texinfo output -------------------------------------------
324
325 # Grouping the document tree into Texinfo files. List of tuples
326 # (source start file, target name, title, author,
327 # dir menu entry, description, category)
328 texinfo_documents = [
329 (master_doc, 'ironic-ui', 'ironic-ui Documentation',
330 author, 'ironic-ui', 'One line description of project.',
331 'Miscellaneous'),
332 ]
333
334 # Documents to append as an appendix to all manuals.
335 #
336 # texinfo_appendices = []
337
338 # If false, no module index is generated.
339 #
340 # texinfo_domain_indices = True
341
342 # How to display URL addresses: 'footnote', 'no', or 'inline'.
343 #
344 # texinfo_show_urls = 'footnote'
345
346 # If true, do not generate a @detailmenu in the "Top" node's menu.
347 #
348 # texinfo_no_detailmenu = False
349
350 # -- Options for Internationalization output ------------------------------
351 locale_dirs = ['locale/']