Debian Codegraph @

releasenotes/source/conf.py

raw
1 # -*- coding: utf-8 -*-
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at
5 #
6 # http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11 # implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # Networking Baremetal Release Notes documentation build configuration file,
16 # created by sphinx-quickstart on Tue Nov 3 17:40:50 2015.
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 # sys.path.insert(0, os.path.abspath('.'))
31
32 # -- General configuration ------------------------------------------------
33
34 # If your documentation needs a minimal Sphinx version, state it here.
35 # needs_sphinx = '1.0'
36
37 # Add any Sphinx extension module names here, as strings. They can be
38 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 # ones.
40 extensions = [
41 'openstackdocstheme',
42 'reno.sphinxext',
43 ]
44
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
47
48 # The suffix of source filenames.
49 source_suffix = '.rst'
50
51 # The encoding of source files.
52 # source_encoding = 'utf-8-sig'
53
54 # The master toctree document.
55 master_doc = 'index'
56
57 # General information about the project.
58 copyright = '2017, The Networking Baremetal team'
59
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
62 # built documents.
63 #
64 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
66 release = ''
67 # The short X.Y version.
68 version = ''
69
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
72 # language = None
73
74 # There are two options for replacing |today|: either, you set today to some
75 # non-false value, then it is used:
76 # today = ''
77 # Else, today_fmt is used as the format for a strftime call.
78 # today_fmt = '%B %d, %Y'
79
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 exclude_patterns = []
83
84 # The reST default role (used for this markup: `text`) to use for all
85 # documents.
86 # default_role = None
87
88 # If true, '()' will be appended to :func: etc. cross-reference text.
89 # add_function_parentheses = True
90
91 # If true, the current module name will be prepended to all description
92 # unit titles (such as .. function::).
93 # add_module_names = True
94
95 # If true, sectionauthor and moduleauthor directives will be shown in the
96 # output. They are ignored by default.
97 # show_authors = False
98
99 # The name of the Pygments (syntax highlighting) style to use.
100 pygments_style = 'native'
101
102 # A list of ignored prefixes for module index sorting.
103 # modindex_common_prefix = []
104
105 # If true, keep warnings as "system message" paragraphs in the built documents.
106 # keep_warnings = False
107
108
109 # -- Options for HTML output ----------------------------------------------
110
111 # The theme to use for HTML and HTML Help pages. See the documentation for
112 # a list of builtin themes.
113 html_theme = 'openstackdocs'
114
115 # openstackdocstheme options
116 openstackdocs_repo_name = 'openstack/networking-baremetal'
117 openstackdocs_use_storyboard = False
118
119 # Theme options are theme-specific and customize the look and feel of a theme
120 # further. For a list of options available for each theme, see the
121 # documentation.
122 # html_theme_options = {}
123
124 # Add any paths that contain custom themes here, relative to this directory.
125 # html_theme_path = []
126
127 # The name for this set of Sphinx documents. If None, it defaults to
128 # "<project> v<release> documentation".
129 # html_title = None
130
131 # A shorter title for the navigation bar. Default is the same as html_title.
132 # html_short_title = None
133
134 # The name of an image file (relative to this directory) to place at the top
135 # of the sidebar.
136 # html_logo = None
137
138 # The name of an image file (within the static path) to use as favicon of the
139 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # pixels large.
141 # html_favicon = None
142
143 # Add any paths that contain custom static files (such as style sheets) here,
144 # relative to this directory. They are copied after the builtin static files,
145 # so a file named "default.css" will overwrite the builtin "default.css".
146 html_static_path = ['_static']
147
148 # Add any extra paths that contain custom files (such as robots.txt or
149 # .htaccess) here, relative to this directory. These files are copied
150 # directly to the root of the documentation.
151 # html_extra_path = []
152
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154 # using the given strftime format.
155 # html_last_updated_fmt = '%b %d, %Y'
156
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
159 # html_use_smartypants = True
160
161 # Custom sidebar templates, maps document names to template names.
162 # html_sidebars = {}
163
164 # Additional templates that should be rendered to pages, maps page names to
165 # template names.
166 # html_additional_pages = {}
167
168 # If false, no module index is generated.
169 # html_domain_indices = True
170
171 # If false, no index is generated.
172 # html_use_index = True
173
174 # If true, the index is split into individual pages for each letter.
175 # html_split_index = False
176
177 # If true, links to the reST sources are added to the pages.
178 # html_show_sourcelink = True
179
180 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181 # html_show_sphinx = True
182
183 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
184 # html_show_copyright = True
185
186 # If true, an OpenSearch description file will be output, and all pages will
187 # contain a <link> tag referring to it. The value of this option must be the
188 # base URL from which the finished HTML is served.
189 # html_use_opensearch = ''
190
191 # This is the file name suffix for HTML files (e.g. ".xhtml").
192 # html_file_suffix = None
193
194 # Output file base name for HTML help builder.
195 htmlhelp_basename = 'NetworkingBaremetalReleaseNotesdoc'
196
197
198 # -- Options for LaTeX output ---------------------------------------------
199
200 # Grouping the document tree into LaTeX files. List of tuples
201 # (source start file, target name, title,
202 # author, documentclass [howto, manual, or own class]).
203 latex_documents = [
204 ('index', 'NetworkingBaremetalReleaseNotes.tex',
205 'Networking Baremetal Release Notes Documentation',
206 'Networking Baremetal Developers', 'manual'),
207 ]
208
209 # The name of an image file (relative to this directory) to place at the top of
210 # the title page.
211 # latex_logo = None
212
213 # For "manual" documents, if this is true, then toplevel headings are parts,
214 # not chapters.
215 # latex_use_parts = False
216
217 # If true, show page references after internal links.
218 # latex_show_pagerefs = False
219
220 # If true, show URL addresses after external links.
221 # latex_show_urls = False
222
223 # Documents to append as an appendix to all manuals.
224 # latex_appendices = []
225
226 # If false, no module index is generated.
227 # latex_domain_indices = True
228
229
230 # -- Options for manual page output ---------------------------------------
231
232 # One entry per manual page. List of tuples
233 # (source start file, name, description, authors, manual section).
234 man_pages = [
235 ('index', 'networkingbaremetalreleasenotes',
236 'Networking Baremetal Release Notes Documentation',
237 ['Networking Baremetal Developers'], 1)
238 ]
239
240 # If true, show URL addresses after external links.
241 # man_show_urls = False
242
243
244 # -- Options for Texinfo output -------------------------------------------
245
246 # Grouping the document tree into Texinfo files. List of tuples
247 # (source start file, target name, title, author,
248 # dir menu entry, description, category)
249 texinfo_documents = [
250 ('index', 'NetworkingBaremetalReleaseNotes',
251 'Networking Baremetal Release Notes Documentation',
252 'networking Baremetal Developers', 'networkingbaremetalreleasenotes',
253 'Neutron plugin that provides deep Ironic/Neutron integration.',
254 'Miscellaneous'),
255 ]
256
257 # Documents to append as an appendix to all manuals.
258 # texinfo_appendices = []
259
260 # If false, no module index is generated.
261 # texinfo_domain_indices = True
262
263 # How to display URL addresses: 'footnote', 'no', or 'inline'.
264 # texinfo_show_urls = 'footnote'
265
266 # If true, do not generate a @detailmenu in the "Top" node's menu.
267 # texinfo_no_detailmenu = False
268
269 # -- Options for Internationalization output ------------------------------
270 locale_dirs = ['locale/']