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 # Zaqar-Client documentation build configuration file, created by
15 # sphinx-quickstart on Tue Dec 20 11:53:00 2016.
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 = 'ZaqarClientReleaseNotes'
58 copyright = '2016, OpenStack Foundation'
59
60 # Release notes are version independent.
61 # The short X.Y version.
62 version = ''
63 # The full version, including alpha/beta/rc tags.
64 release = ''
65
66 # The language for content autogenerated by Sphinx. Refer to documentation
67 # for a list of supported languages.
68 # language = None
69
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
72 # today = ''
73 # Else, today_fmt is used as the format for a strftime call.
74 # today_fmt = '%B %d, %Y'
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 exclude_patterns = []
79
80 # The reST default role (used for this markup: `text`) to use for all
81 # documents.
82 # default_role = None
83
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 # add_function_parentheses = True
86
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 # add_module_names = True
90
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
93 # show_authors = False
94
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'native'
97
98 # A list of ignored prefixes for module index sorting.
99 # modindex_common_prefix = []
100
101 # If true, keep warnings as "system message" paragraphs in the built documents.
102 # keep_warnings = False
103
104
105 # -- Options for HTML output ----------------------------------------------
106
107 # The theme to use for HTML and HTML Help pages. See the documentation for
108 # a list of builtin themes.
109 html_theme = 'openstackdocs'
110
111 # Theme options are theme-specific and customize the look and feel of a theme
112 # further. For a list of options available for each theme, see the
113 # documentation.
114 # html_theme_options = {}
115
116 # Add any paths that contain custom themes here, relative to this directory.
117 # html_theme_path = []
118
119 # The name for this set of Sphinx documents. If None, it defaults to
120 # "<project> v<release> documentation".
121 # html_title = None
122
123 # A shorter title for the navigation bar. Default is the same as html_title.
124 # html_short_title = None
125
126 # The name of an image file (relative to this directory) to place at the top
127 # of the sidebar.
128 # html_logo = None
129
130 # The name of an image file (within the static path) to use as favicon of the
131 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
132 # pixels large.
133 # html_favicon = None
134
135 # Add any paths that contain custom static files (such as style sheets) here,
136 # relative to this directory. They are copied after the builtin static files,
137 # so a file named "default.css" will overwrite the builtin "default.css".
138 # html_static_path = ['_static']
139
140 # Add any extra paths that contain custom files (such as robots.txt or
141 # .htaccess) here, relative to this directory. These files are copied
142 # directly to the root of the documentation.
143 # html_extra_path = []
144
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146 # using the given strftime format.
147 # html_last_updated_fmt = '%b %d, %Y'
148
149 # If true, SmartyPants will be used to convert quotes and dashes to
150 # typographically correct entities.
151 # html_use_smartypants = True
152
153 # Custom sidebar templates, maps document names to template names.
154 # html_sidebars = {}
155
156 # Additional templates that should be rendered to pages, maps page names to
157 # template names.
158 # html_additional_pages = {}
159
160 # If false, no module index is generated.
161 # html_domain_indices = True
162
163 # If false, no index is generated.
164 # html_use_index = True
165
166 # If true, the index is split into individual pages for each letter.
167 # html_split_index = False
168
169 # If true, links to the reST sources are added to the pages.
170 # html_show_sourcelink = True
171
172 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
173 # html_show_sphinx = True
174
175 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
176 # html_show_copyright = True
177
178 # If true, an OpenSearch description file will be output, and all pages will
179 # contain a <link> tag referring to it. The value of this option must be the
180 # base URL from which the finished HTML is served.
181 # html_use_opensearch = ''
182
183 # This is the file name suffix for HTML files (e.g. ".xhtml").
184 # html_file_suffix = None
185
186 # Output file base name for HTML help builder.
187 htmlhelp_basename = 'ZaqarClientReleaseNotesdoc'
188
189
190 # -- Options for LaTeX output ---------------------------------------------
191
192 # The item in latex_elements:
193 # The paper size ('letterpaper' or 'a4paper').
194 # 'papersize': 'letterpaper',
195 # The font size ('10pt', '11pt' or '12pt').
196 # 'pointsize': '10pt',
197 # Additional stuff for the LaTeX preamble.
198 # 'preamble': '',
199 latex_elements = {}
200
201 # Grouping the document tree into LaTeX files. List of tuples
202 # (source start file, target name, title,
203 # author, documentclass [howto, manual, or own class]).
204 latex_documents = [
205 ('index', 'ZaqarClientReleaseNotes.tex',
206 'ZaqarClient ReleaseNotes Documentation',
207 'OpenStack Foundation', 'manual'),
208 ]
209
210 # The name of an image file (relative to this directory) to place at the top of
211 # the title page.
212 # latex_logo = None
213
214 # For "manual" documents, if this is true, then toplevel headings are parts,
215 # not chapters.
216 # latex_use_parts = False
217
218 # If true, show page references after internal links.
219 # latex_show_pagerefs = False
220
221 # If true, show URL addresses after external links.
222 # latex_show_urls = False
223
224 # Documents to append as an appendix to all manuals.
225 # latex_appendices = []
226
227 # If false, no module index is generated.
228 # latex_domain_indices = True
229
230
231 # -- Options for manual page output ---------------------------------------
232
233 # One entry per manual page. List of tuples
234 # (source start file, name, description, authors, manual section).
235 man_pages = [
236 ('index', 'ZaqarClientReleaseNotes',
237 'ZaqarClient ReleaseNotes Documentation',
238 ['OpenStack Foundation'], 1)
239 ]
240
241 # If true, show URL addresses after external links.
242 # man_show_urls = False
243
244
245 # -- Options for Texinfo output -------------------------------------------
246
247 # Grouping the document tree into Texinfo files. List of tuples
248 # (source start file, target name, title, author,
249 # dir menu entry, description, category)
250 texinfo_documents = [
251 ('index', 'ZaqarClientReleaseNotes',
252 'ZaqarClient ReleaseNotes Documentation',
253 'OpenStack Foundation', 'ZaqarClientReleaseNotes',
254 'One line description of project.',
255 'Miscellaneous'),
256 ]
257
258 # Documents to append as an appendix to all manuals.
259 # texinfo_appendices = []
260
261 # If false, no module index is generated.
262 # texinfo_domain_indices = True
263
264 # How to display URL addresses: 'footnote', 'no', or 'inline'.
265 # texinfo_show_urls = 'footnote'
266
267 # If true, do not generate a @detailmenu in the "Top" node's menu.
268 # texinfo_no_detailmenu = False
269
270 # -- Options for Internationalization output ------------------------------
271 locale_dirs = ['locale/']
272
273 # -- Options for openstackdocstheme -------------------------------------------
274 openstackdocs_repo_name = 'openstack/python-zaqarclient'
275 openstackdocs_bug_project = 'python-zaqarclient'
276 openstackdocs_bug_tag = ''
277 openstackdocs_auto_name = False