Debian Codegraph @

releasenotes/source/conf.py

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