1 # -*- coding: utf-8 -*-
3 # ONAP documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jul 19 16:25:31 2017.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 #sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
27 needs_sphinx = '1.5.3'
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 'sphinx.ext.graphviz',
38 'sphinx.ext.viewcode',
39 'sphinxcontrib.blockdiag'
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path = ['_templates']
45 # The suffix(es) of source filenames.
46 # You can specify multiple suffix as a list of string:
47 # source_suffix = ['.rst', '.md']
48 source_suffix = '.rst'
50 # The encoding of source files.
51 #source_encoding = 'utf-8-sig'
53 # The master toctree document.
56 # General information about the project.
58 copyright = u'2017, ONAP Contributors'
59 author = u'ONAP Contributors'
61 # The version info for the project you're documenting, acts as replacement for
62 # |version| and |release|, also used in various other places throughout the
65 # The short X.Y version.
66 version = 'pre-release alpha'
67 # The full version, including alpha/beta/rc tags.
68 release = 'Amsterdam 0.1 alpha'
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
73 # This is also used if you do content translation via gettext catalogs.
74 # Usually you set "language" from the command line for these cases.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
83 # List of patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
90 # The reST default role (used for this markup: `text`) to use for all
94 # If true, '()' will be appended to :func: etc. cross-reference text.
95 #add_function_parentheses = True
97 # If true, the current module name will be prepended to all description
98 # unit titles (such as .. function::).
99 #add_module_names = True
101 # If true, sectionauthor and moduleauthor directives will be shown in the
102 # output. They are ignored by default.
103 #show_authors = False
105 # The name of the Pygments (syntax highlighting) style to use.
106 pygments_style = 'sphinx'
108 # A list of ignored prefixes for module index sorting.
109 #modindex_common_prefix = []
111 # If true, keep warnings as "system message" paragraphs in the built documents.
112 #keep_warnings = False
114 # If true, `todo` and `todoList` produce output, else they produce nothing.
115 todo_include_todos = True
118 # -- Options for HTML output ----------------------------------------------
120 # The theme to use for HTML and HTML Help pages. See the documentation for
121 # a list of builtin themes.
122 html_theme = 'classic'
124 # Theme options are theme-specific and customize the look and feel of a theme
125 # further. For a list of options available for each theme, see the
127 #html_theme_options = {}
129 # Add any paths that contain custom themes here, relative to this directory.
130 #html_theme_path = []
132 # The name for this set of Sphinx documents. If None, it defaults to
133 # "<project> v<release> documentation".
136 # A shorter title for the navigation bar. Default is the same as html_title.
137 #html_short_title = None
139 # The name of an image file (relative to this directory) to place at the top
141 html_logo = '_static/logo_onap_2017.png'
143 # The name of an image file (within the static path) to use as favicon of the
144 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
146 html_favicon = '_static/favicon.ico'
148 # Add any paths that contain custom static files (such as style sheets) here,
149 # relative to this directory. They are copied after the builtin static files,
150 # so a file named "default.css" will overwrite the builtin "default.css".
151 html_static_path = ['_static']
153 # Add any extra paths that contain custom files (such as robots.txt or
154 # .htaccess) here, relative to this directory. These files are copied
155 # directly to the root of the documentation.
156 #html_extra_path = []
158 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
159 # using the given strftime format.
160 #html_last_updated_fmt = '%b %d, %Y'
162 # If true, SmartyPants will be used to convert quotes and dashes to
163 # typographically correct entities.
164 #html_use_smartypants = True
166 # Custom sidebar templates, maps document names to template names.
169 # Additional templates that should be rendered to pages, maps page names to
171 #html_additional_pages = {}
173 # If false, no module index is generated.
174 #html_domain_indices = True
176 # If false, no index is generated.
177 #html_use_index = True
179 # If true, the index is split into individual pages for each letter.
180 #html_split_index = False
182 # If true, links to the reST sources are added to the pages.
183 #html_show_sourcelink = True
185 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186 #html_show_sphinx = True
188 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189 #html_show_copyright = True
191 # If true, an OpenSearch description file will be output, and all pages will
192 # contain a <link> tag referring to it. The value of this option must be the
193 # base URL from which the finished HTML is served.
194 #html_use_opensearch = ''
196 # This is the file name suffix for HTML files (e.g. ".xhtml").
197 #html_file_suffix = None
199 # Language to be used for generating the HTML full-text search index.
200 # Sphinx supports the following languages:
201 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
202 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
203 #html_search_language = 'en'
205 # A dictionary with options for the search language support, empty by default.
206 # Now only 'ja' uses this config value
207 #html_search_options = {'type': 'default'}
209 # The name of a javascript file (relative to the configuration directory) that
210 # implements a search results scorer. If empty, the default will be used.
211 #html_search_scorer = 'scorer.js'
213 # Output file base name for HTML help builder.
214 htmlhelp_basename = 'ONAPdoc'
216 # -- Options for LaTeX output ---------------------------------------------
219 # The paper size ('letterpaper' or 'a4paper').
220 #'papersize': 'letterpaper',
222 # The font size ('10pt', '11pt' or '12pt').
223 #'pointsize': '10pt',
225 # Additional stuff for the LaTeX preamble.
228 # Latex figure (float) alignment
229 #'figure_align': 'htbp',
232 # Grouping the document tree into LaTeX files. List of tuples
233 # (source start file, target name, title,
234 # author, documentclass [howto, manual, or own class]).
236 (master_doc, 'ONAP.tex', u'ONAP Documentation',
237 u'ONAP Contributors', 'manual'),
240 # The name of an image file (relative to this directory) to place at the top of
244 # For "manual" documents, if this is true, then toplevel headings are parts,
246 #latex_use_parts = False
248 # If true, show page references after internal links.
249 #latex_show_pagerefs = False
251 # If true, show URL addresses after external links.
252 #latex_show_urls = False
254 # Documents to append as an appendix to all manuals.
255 #latex_appendices = []
257 # If false, no module index is generated.
258 #latex_domain_indices = True
261 # -- Options for manual page output ---------------------------------------
263 # One entry per manual page. List of tuples
264 # (source start file, name, description, authors, manual section).
266 (master_doc, 'onap', u'ONAP Documentation',
270 # If true, show URL addresses after external links.
271 #man_show_urls = False
274 # -- Options for Texinfo output -------------------------------------------
276 # Grouping the document tree into Texinfo files. List of tuples
277 # (source start file, target name, title, author,
278 # dir menu entry, description, category)
279 texinfo_documents = [
280 (master_doc, 'ONAP', u'ONAP Documentation',
281 author, 'ONAP', 'Open Network Automation Platform',
285 # Documents to append as an appendix to all manuals.
286 #texinfo_appendices = []
288 # If false, no module index is generated.
289 #texinfo_domain_indices = True
291 # How to display URL addresses: 'footnote', 'no', or 'inline'.
292 #texinfo_show_urls = 'footnote'
294 # If true, do not generate a @detailmenu in the "Top" node's menu.
295 #texinfo_no_detailmenu = False
298 # -- Options for Epub output ----------------------------------------------
300 # Bibliographic Dublin Core info.
303 epub_publisher = author
304 epub_copyright = copyright
306 # The basename for the epub file. It defaults to the project name.
307 #epub_basename = project
309 # The HTML theme for the epub output. Since the default themes are not optimized
310 # for small screen space, using the same theme for HTML and epub output is
311 # usually not wise. This defaults to 'epub', a theme designed to save visual
315 # The language of the text. It defaults to the language option
316 # or 'en' if the language is not set.
319 # The scheme of the identifier. Typical schemes are ISBN or URL.
322 # The unique identifier of the text. This can be a ISBN number
323 # or the project homepage.
324 #epub_identifier = ''
326 # A unique identification for the text.
329 # A tuple containing the cover image and cover page html template filenames.
332 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
335 # HTML files that should be inserted before the pages created by sphinx.
336 # The format is a list of tuples containing the path and title.
339 # HTML files shat should be inserted after the pages created by sphinx.
340 # The format is a list of tuples containing the path and title.
341 #epub_post_files = []
343 # A list of files that should not be packed into the epub file.
344 epub_exclude_files = ['search.html']
346 # The depth of the table of contents in toc.ncx.
349 # Allow duplicate toc entries.
352 # Choose between 'default' and 'includehidden'.
353 #epub_tocscope = 'default'
355 # Fix unsupported image types using the Pillow.
356 #epub_fix_images = False
358 # Scale large images.
359 #epub_max_image_width = 0
361 # How to display URL addresses: 'footnote', 'no', or 'inline'.
362 #epub_show_urls = 'inline'
364 # If false, no index is generated.
365 #epub_use_index = True