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