Debian Codegraph @

api-ref/source/conf.py

raw
1 # Copyright (c) 2010 OpenStack Foundation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12 # implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 #
17 # This file is execfile()'d with the current directory set to its containing
18 # 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 import os
27 import sys
28
29
30 # If extensions (or modules to document with autodoc) are in another directory,
31 # add these directories to sys.path here. If the directory is relative to the
32 # documentation root, use os.path.abspath to make it absolute, like shown here.
33 sys.path = [
34 os.path.abspath('../..'),
35 os.path.abspath('../../bin')
36 ] + sys.path
37
38 # -- General configuration ---------------------------------------------------
39
40 # Add any Sphinx extension module names here, as strings. They can be
41 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
42 extensions = ['sphinx.ext.coverage',
43 'sphinx.ext.ifconfig',
44 'sphinx.ext.graphviz',
45 'stevedore.sphinxext',
46 'oslo_config.sphinxext',
47 'sphinx.ext.viewcode',
48 'oslo_config.sphinxconfiggen',
49 'sphinx.ext.mathjax',
50 'wsmeext.sphinxext',
51 'sphinx.ext.autodoc',
52 'sphinxcontrib.pecanwsme.rest',
53 'sphinxcontrib.httpdomain',
54 'os_api_ref',
55 'openstackdocstheme',
56 'oslo_policy.sphinxext',
57 'oslo_policy.sphinxpolicygen',
58 ]
59
60 # Ignore the following warning: WARNING: while setting up extension
61 # wsmeext.sphinxext: directive 'autoattribute' is already registered,
62 # it will be overridden.
63 suppress_warnings = ['app.add_directive']
64
65 # openstackdocstheme options
66 openstackdocs_repo_name = 'openstack/cloudkitty'
67 openstackdocs_pdf_link = True
68 openstackdocs_use_storyboard = True
69
70 config_generator_config_file = '../../etc/oslo-config-generator/cloudkitty.conf'
71 policy_generator_config_file = '../../etc/oslo-policy-generator/cloudkitty.conf'
72 sample_policy_basename = sample_config_basename = '_static/cloudkitty'
73
74 # Add any paths that contain templates here, relative to this directory.
75 # templates_path = []
76
77 # The suffix of source filenames.
78 source_suffix = '.rst'
79
80 # The encoding of source files.
81 #source_encoding = 'utf-8'
82
83 # The master toctree document.
84 master_doc = 'index'
85
86 # General information about the project.
87 copyright = '2014-present, OpenStack Foundation.'
88
89 # The language for content autogenerated by Sphinx. Refer to documentation
90 # for a list of supported languages.
91 #language = None
92
93 # There are two options for replacing |today|: either, you set today to some
94 # non-false value, then it is used:
95 #today = ''
96 # Else, today_fmt is used as the format for a strftime call.
97 #today_fmt = '%B %d, %Y'
98
99 # List of documents that shouldn't be included in the build.
100 #unused_docs = []
101
102 # List of directories, relative to source directory, that shouldn't be searched
103 # for source files.
104 #exclude_trees = ['api']
105 exclude_patterns = []
106
107 # The reST default role (for this markup: `text`) to use for all documents.
108 #default_role = None
109
110 # If true, '()' will be appended to :func: etc. cross-reference text.
111 add_function_parentheses = True
112
113 # If true, the current module name will be prepended to all description
114 # unit titles (such as .. function::).
115 add_module_names = True
116
117 # If true, sectionauthor and moduleauthor directives will be shown in the
118 # output. They are ignored by default.
119 show_authors = True
120
121 # The name of the Pygments (syntax highlighting) style to use.
122 pygments_style = 'native'
123
124 # A list of ignored prefixes for module index sorting.
125 modindex_common_prefix = ['cloudkitty.']
126
127 # -- Options for man page output --------------------------------------------
128
129 # Grouping the document tree for man pages.
130 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
131
132 man_pages = [
133 ('index', 'cloudkitty', 'cloudkitty Documentation',
134 ['Objectif Libre'], 1)
135 ]
136
137 # -- Options for HTML output -------------------------------------------------
138
139 # The theme to use for HTML and HTML Help pages. Major themes that come with
140 # Sphinx are currently 'default' and 'sphinxdoc'.
141 # html_theme_path = ["."]
142 # html_theme = '_theme'
143 html_theme = 'openstackdocs'
144
145 # Theme options are theme-specific and customize the look and feel of a theme
146 # further. For a list of options available for each theme, see the
147 # documentation.
148 html_theme_options = {
149 "show_other_versions": "True",
150 }
151
152 # Add any paths that contain custom themes here, relative to this directory.
153 #html_theme_path = ['_theme']
154 #html_theme_path = [openstackdocstheme.get_html_theme_path()]
155
156 # The name for this set of Sphinx documents. If None, it defaults to
157 # "<project> v<release> documentation".
158 #html_title = None
159
160 # A shorter title for the navigation bar. Default is the same as html_title.
161 #html_short_title = None
162
163 # The name of an image file (relative to this directory) to place at the top
164 # of the sidebar.
165 #html_logo = None
166
167 # The name of an image file (within the static path) to use as favicon of the
168 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
169 # pixels large.
170 #html_favicon = None
171
172 # Add any paths that contain custom static files (such as style sheets) here,
173 # relative to this directory. They are copied after the builtin static files,
174 # so a file named "default.css" will overwrite the builtin "default.css".
175 html_static_path = ['_static']
176
177 # If true, SmartyPants will be used to convert quotes and dashes to
178 # typographically correct entities.
179 #html_use_smartypants = True
180
181 # Custom sidebar templates, maps document names to template names.
182 #html_sidebars = {}
183
184 # Additional templates that should be rendered to pages, maps page names to
185 # template names.
186 #html_additional_pages = {}
187
188 # If false, no module index is generated.
189 html_use_modindex = True
190
191 # If false, no index is generated.
192 html_use_index = True
193
194 # If true, the index is split into individual pages for each letter.
195 #html_split_index = False
196
197 # If true, links to the reST sources are added to the pages.
198 #html_show_sourcelink = True
199
200 # If true, an OpenSearch description file will be output, and all pages will
201 # contain a <link> tag referring to it. The value of this option must be the
202 # base URL from which the finished HTML is served.
203 #html_use_opensearch = ''
204
205 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
206 #html_file_suffix = ''
207
208 # Output file base name for HTML help builder.
209 htmlhelp_basename = 'cloudkittydoc'
210
211
212 # -- Options for LaTeX output ------------------------------------------------
213
214 # The paper size ('letter' or 'a4').
215 #latex_paper_size = 'letter'
216
217 # The font size ('10pt', '11pt' or '12pt').
218 #latex_font_size = '10pt'
219
220 # Grouping the document tree into LaTeX files. List of tuples
221 # (source start file, target name, title, author,
222 # documentclass [howto/manual]).
223 latex_documents = [
224 ('pdf-index', 'doc-cloudkitty.tex', 'Cloudkitty Documentation',
225 'Cloudkitty Team', 'manual'),
226 ]
227
228 # The name of an image file (relative to this directory) to place at the top of
229 # the title page.
230 #latex_logo = None
231
232 # For "manual" documents, if this is true, then toplevel headings are parts,
233 # not chapters.
234 #latex_use_parts = False
235
236 # Additional stuff for the LaTeX preamble.
237 #latex_preamble = ''
238
239 # Documents to append as an appendix to all manuals.
240 #latex_appendices = []
241
242 # If false, no module index is generated.
243 #latex_use_modindex = True
244
245 # If false, no module index is generated.
246 latex_domain_indices = False
247
248 latex_elements = {
249 'makeindex': '',
250 'printindex': '',
251 'preamble': r'\setcounter{tocdepth}{3}',
252 }
253
254 # Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
255 latex_use_xindy = False