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.
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',
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
44 # The suffix(es) of source filenames.
45 # You can specify multiple suffix as a list of string:
46 # source_suffix = ['.rst', '.md']
47 source_suffix = '.rst'
49 # The encoding of source files.
50 #source_encoding = 'utf-8-sig'
52 # The master toctree document.
55 # General information about the project.
57 copyright = u'2017, ONAP Contributors'
58 author = u'ONAP Contributors'
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
64 # The short X.Y version.
66 # The full version, including alpha/beta/rc tags.
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
76 # There are two options for replacing |today|: either, you set today to some
77 # non-false value, then it is used:
79 # Else, today_fmt is used as the format for a strftime call.
80 #today_fmt = '%B %d, %Y'
82 # List of patterns, relative to source directory, that match files and
83 # directories to ignore when looking for source files.
84 exclude_patterns = ['_build']
86 # The reST default role (used for this markup: `text`) to use for all
90 # If true, '()' will be appended to :func: etc. cross-reference text.
91 #add_function_parentheses = True
93 # If true, the current module name will be prepended to all description
94 # unit titles (such as .. function::).
95 #add_module_names = True
97 # If true, sectionauthor and moduleauthor directives will be shown in the
98 # output. They are ignored by default.
101 # The name of the Pygments (syntax highlighting) style to use.
102 pygments_style = 'sphinx'
104 # A list of ignored prefixes for module index sorting.
105 #modindex_common_prefix = []
107 # If true, keep warnings as "system message" paragraphs in the built documents.
108 #keep_warnings = False
110 # If true, `todo` and `todoList` produce output, else they produce nothing.
111 todo_include_todos = True
114 # -- Options for HTML output ----------------------------------------------
116 # The theme to use for HTML and HTML Help pages. See the documentation for
117 # a list of builtin themes.
118 html_theme = 'classic'
120 # Theme options are theme-specific and customize the look and feel of a theme
121 # further. For a list of options available for each theme, see the
123 #html_theme_options = {}
125 # Add any paths that contain custom themes here, relative to this directory.
126 #html_theme_path = []
128 # The name for this set of Sphinx documents. If None, it defaults to
129 # "<project> v<release> documentation".
132 # A shorter title for the navigation bar. Default is the same as html_title.
133 #html_short_title = None
135 # The name of an image file (relative to this directory) to place at the top
137 html_logo = '_static/logo_onap_2017.png'
139 # The name of an image file (within the static path) to use as favicon of the
140 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
142 html_favicon = '_static/favicon.ico'
144 # Add any paths that contain custom static files (such as style sheets) here,
145 # relative to this directory. They are copied after the builtin static files,
146 # so a file named "default.css" will overwrite the builtin "default.css".
147 html_static_path = ['_static']
149 # Add any extra paths that contain custom files (such as robots.txt or
150 # .htaccess) here, relative to this directory. These files are copied
151 # directly to the root of the documentation.
152 #html_extra_path = []
154 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
155 # using the given strftime format.
156 #html_last_updated_fmt = '%b %d, %Y'
158 # If true, SmartyPants will be used to convert quotes and dashes to
159 # typographically correct entities.
160 #html_use_smartypants = True
162 # Custom sidebar templates, maps document names to template names.
165 # Additional templates that should be rendered to pages, maps page names to
167 #html_additional_pages = {}
169 # If false, no module index is generated.
170 #html_domain_indices = True
172 # If false, no index is generated.
173 #html_use_index = True
175 # If true, the index is split into individual pages for each letter.
176 #html_split_index = False
178 # If true, links to the reST sources are added to the pages.
179 #html_show_sourcelink = True
181 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
182 #html_show_sphinx = True
184 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
185 #html_show_copyright = True
187 # If true, an OpenSearch description file will be output, and all pages will
188 # contain a <link> tag referring to it. The value of this option must be the
189 # base URL from which the finished HTML is served.
190 #html_use_opensearch = ''
192 # This is the file name suffix for HTML files (e.g. ".xhtml").
193 #html_file_suffix = None
195 # Language to be used for generating the HTML full-text search index.
196 # Sphinx supports the following languages:
197 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
198 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
199 #html_search_language = 'en'
201 # A dictionary with options for the search language support, empty by default.
202 # Now only 'ja' uses this config value
203 #html_search_options = {'type': 'default'}
205 # The name of a javascript file (relative to the configuration directory) that
206 # implements a search results scorer. If empty, the default will be used.
207 #html_search_scorer = 'scorer.js'
209 # Output file base name for HTML help builder.
210 htmlhelp_basename = 'ONAPdoc'
212 # -- Options for LaTeX output ---------------------------------------------
215 # The paper size ('letterpaper' or 'a4paper').
216 #'papersize': 'letterpaper',
218 # The font size ('10pt', '11pt' or '12pt').
219 #'pointsize': '10pt',
221 # Additional stuff for the LaTeX preamble.
224 # Latex figure (float) alignment
225 #'figure_align': 'htbp',
228 # Grouping the document tree into LaTeX files. List of tuples
229 # (source start file, target name, title,
230 # author, documentclass [howto, manual, or own class]).
232 (master_doc, 'ONAP.tex', u'ONAP Documentation',
233 u'ONAP Contributors', 'manual'),
236 # The name of an image file (relative to this directory) to place at the top of
240 # For "manual" documents, if this is true, then toplevel headings are parts,
242 #latex_use_parts = False
244 # If true, show page references after internal links.
245 #latex_show_pagerefs = False
247 # If true, show URL addresses after external links.
248 #latex_show_urls = False
250 # Documents to append as an appendix to all manuals.
251 #latex_appendices = []
253 # If false, no module index is generated.
254 #latex_domain_indices = True
257 # -- Options for manual page output ---------------------------------------
259 # One entry per manual page. List of tuples
260 # (source start file, name, description, authors, manual section).
262 (master_doc, 'onap', u'ONAP Documentation',
266 # If true, show URL addresses after external links.
267 #man_show_urls = False
270 # -- Options for Texinfo output -------------------------------------------
272 # Grouping the document tree into Texinfo files. List of tuples
273 # (source start file, target name, title, author,
274 # dir menu entry, description, category)
275 texinfo_documents = [
276 (master_doc, 'ONAP', u'ONAP Documentation',
277 author, 'ONAP', 'Open Network Automation Platform',
281 # Documents to append as an appendix to all manuals.
282 #texinfo_appendices = []
284 # If false, no module index is generated.
285 #texinfo_domain_indices = True
287 # How to display URL addresses: 'footnote', 'no', or 'inline'.
288 #texinfo_show_urls = 'footnote'
290 # If true, do not generate a @detailmenu in the "Top" node's menu.
291 #texinfo_no_detailmenu = False
294 # -- Options for Epub output ----------------------------------------------
296 # Bibliographic Dublin Core info.
299 epub_publisher = author
300 epub_copyright = copyright
302 # The basename for the epub file. It defaults to the project name.
303 #epub_basename = project
305 # The HTML theme for the epub output. Since the default themes are not optimized
306 # for small screen space, using the same theme for HTML and epub output is
307 # usually not wise. This defaults to 'epub', a theme designed to save visual
311 # The language of the text. It defaults to the language option
312 # or 'en' if the language is not set.
315 # The scheme of the identifier. Typical schemes are ISBN or URL.
318 # The unique identifier of the text. This can be a ISBN number
319 # or the project homepage.
320 #epub_identifier = ''
322 # A unique identification for the text.
325 # A tuple containing the cover image and cover page html template filenames.
328 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
331 # HTML files that should be inserted before the pages created by sphinx.
332 # The format is a list of tuples containing the path and title.
335 # HTML files shat should be inserted after the pages created by sphinx.
336 # The format is a list of tuples containing the path and title.
337 #epub_post_files = []
339 # A list of files that should not be packed into the epub file.
340 epub_exclude_files = ['search.html']
342 # The depth of the table of contents in toc.ncx.
345 # Allow duplicate toc entries.
348 # Choose between 'default' and 'includehidden'.
349 #epub_tocscope = 'default'
351 # Fix unsupported image types using the Pillow.
352 #epub_fix_images = False
354 # Scale large images.
355 #epub_max_image_width = 0
357 # How to display URL addresses: 'footnote', 'no', or 'inline'.
358 #epub_show_urls = 'inline'
360 # If false, no index is generated.
361 #epub_use_index = True