Debian Codegraph @

releasenotes/source/conf.py

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