"Fossies" - the Fresh Open Source Software Archive 
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Python source code syntax highlighting (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
For more information about "conf.py" see the
Fossies "Dox" file reference documentation and the latest
Fossies "Diffs" side-by-side code changes report:
2.7.0_vs_2.9.0.
1 # -*- coding: utf-8 -*-
2 #
3 # monasca-log-api documentation build configuration file, created by
4 # sphinx-quickstart on Wed Nov 18 12:02:03 2015.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 import os
16 import sys
17
18 from monasca_log_api.version import version_info
19
20 sys.path = [
21 os.path.abspath('../..'),
22 os.path.abspath('../../bin')
23 ] + sys.path
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 needs_sphinx = '1.6'
29
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 # ones.
33 extensions = [
34 'sphinx.ext.coverage',
35 'sphinx.ext.ifconfig',
36 'sphinx.ext.graphviz',
37 'sphinx.ext.autodoc',
38 'sphinx.ext.viewcode',
39 'oslo_config.sphinxconfiggen',
40 'oslo_config.sphinxext',
41 'openstackdocstheme',
42 'oslo_policy.sphinxpolicygen'
43 ]
44
45 # geeneral information about project
46 repository_name = u'openstack/monasca-log-api'
47 project = u'Monasca Log Dev Docs'
48 version = version_info.version_string()
49 release = version_info.release_string()
50 bug_project = u'monasca-log-api'
51 bug_tag = u'doc'
52 copyright = u'2014-present, OpenStack Foundation'
53 author = u'OpenStack Foundation'
54
55 # sample config
56 config_generator_config_file = [
57 ('config-generator/monasca-log-api.conf', '_static/monasca-log-api')
58
59 ]
60 policy_generator_config_file = [
61 ('config-generator/policy.conf', '_static/log-api')
62
63 ]
64
65 # Add any paths that contain templates here, relative to this directory.
66 templates_path = ['_templates']
67
68 # The suffix(es) of source filenames.
69 source_suffix = '.rst'
70
71 # The encoding of source files.
72 source_encoding = 'utf-8'
73
74 # The master toctree document.
75 master_doc = 'index'
76
77 # List of patterns, relative to source directory, that match files and
78 # directories to ignore when looking for source files.
79 exclude_patterns = [
80 'common',
81 'doc',
82 'documentation',
83 'etc',
84 'java'
85 ]
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 = True
97
98 # The name of the Pygments (syntax highlighting) style to use.
99 pygments_style = 'sphinx'
100
101 # A list of ignored prefixes for module index sorting.
102 modindex_common_prefix = ['monasca_log_api.', 'monasca']
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 # doc. 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 not '', a 'Last updated on:' timestamp is inserted at every page bottom,
145 # using the given strftime format.
146 html_last_updated_fmt = '%Y-%m-%d %H:%M'
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 false, no module index is generated.
166 html_use_modindex = True
167
168 # If true, the index is split into individual pages for each letter.
169 #html_split_index = False
170
171 # If true, links to the reST sources are added to the pages.
172 #html_show_sourcelink = True
173
174 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175 #html_show_sphinx = True
176
177 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178 #html_show_copyright = True
179
180 # If true, an OpenSearch description file will be output, and all pages will
181 # contain a <link> tag referring to it. The value of this option must be the
182 # base URL from which the finished HTML is served.
183 #html_use_opensearch = ''
184
185 # This is the file name suffix for HTML files (e.g. ".xhtml").
186 #html_file_suffix = None
187
188 # Language to be used for generating the HTML full-text search index.
189 # Sphinx supports the following languages:
190 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
191 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
192 #html_search_language = 'en'
193
194 # A dictionary with options for the search language support, empty by default.
195 # Now only 'ja' uses this config value
196 #html_search_options = {'type': 'default'}
197
198 # The name of a javascript file (relative to the configuration directory) that
199 # implements a search results scorer. If empty, the default will be used.
200 #html_search_scorer = 'scorer.js'
201
202 # Output file base name for HTML help builder.
203 htmlhelp_basename = 'monasca-log-apidoc'
204
205 # -- Options for LaTeX output ---------------------------------------------
206
207 latex_elements = {
208 # The paper size ('letterpaper' or 'a4paper').
209 #'papersize': 'letterpaper',
210
211 # The font size ('10pt', '11pt' or '12pt').
212 #'pointsize': '10pt',
213
214 # Additional stuff for the LaTeX preamble.
215 #'preamble': '',
216
217 # Latex figure (float) alignment
218 #'figure_align': 'htbp',
219 }
220
221 # Grouping the document tree into LaTeX files. List of tuples
222 # (source start file, target name, title,
223 # author, documentclass [howto, manual, or own class]).
224 latex_documents = [
225 (master_doc, 'monasca-log-api.tex', u'monasca-log-api Documentation',
226 u'Openstack Foundation \\textless{}monasca@lists.launchpad.net\\textgreater{}', 'manual'),
227 ]
228
229 # The name of an image file (relative to this directory) to place at the top of
230 # the title page.
231 #latex_logo = None
232
233 # For "manual" documents, if this is true, then toplevel headings are parts,
234 # not chapters.
235 #latex_use_parts = False
236
237 # If true, show page references after internal links.
238 #latex_show_pagerefs = False
239
240 # If true, show URL addresses after external links.
241 #latex_show_urls = False
242
243 # Documents to append as an appendix to all manuals.
244 #latex_appendices = []
245
246 # If false, no module index is generated.
247 #latex_domain_indices = True
248
249
250 # -- Options for manual page output ---------------------------------------
251
252 # One entry per manual page. List of tuples
253 # (source start file, name, description, authors, manual section).
254 man_pages = [
255 (master_doc, 'monasca-log-api', u'monasca-log-api Documentation',
256 [author], 1)
257 ]
258
259 # If true, show URL addresses after external links.
260 #man_show_urls = False
261
262
263 # -- Options for Texinfo output -------------------------------------------
264
265 # Grouping the document tree into Texinfo files. List of tuples
266 # (source start file, target name, title, author,
267 # dir menu entry, description, category)
268 texinfo_documents = [
269 (master_doc, 'monasca-log-api', u'monasca-log-api Documentation',
270 author, 'monasca-log-api', 'Rest-API to collect logs from your cloud.',
271 'Miscellaneous'),
272 ]
273
274 # Documents to append as an appendix to all manuals.
275 #texinfo_appendices = []
276
277 # If false, no module index is generated.
278 #texinfo_domain_indices = True
279
280 # How to display URL addresses: 'footnote', 'no', or 'inline'.
281 #texinfo_show_urls = 'footnote'
282
283 # If true, do not generate a @detailmenu in the "Top" node's menu.
284 #texinfo_no_detailmenu = False
285
286
287 # Example configuration for intersphinx: refer to the Python standard library.
288 intersphinx_mapping = {'https://doc.python.org/': None}