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',
40 'sphinxcontrib.seqdiag'
43 # Font path for seqdiag
44 seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
46 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['_templates']
49 # The suffix(es) of source filenames.
50 # You can specify multiple suffix as a list of string:
51 # source_suffix = ['.rst', '.md']
52 source_suffix = '.rst'
54 # The encoding of source files.
55 #source_encoding = 'utf-8-sig'
57 # The master toctree document.
60 # General information about the project.
62 copyright = u'2017, ONAP Contributors'
63 author = u'ONAP Contributors'
65 # The version info for the project you're documenting, acts as replacement for
66 # |version| and |release|, also used in various other places throughout the
69 # The short X.Y version.
70 version = 'pre-release alpha'
71 # The full version, including alpha/beta/rc tags.
72 release = 'Amsterdam 0.1 alpha'
74 # The language for content autogenerated by Sphinx. Refer to documentation
75 # for a list of supported languages.
77 # This is also used if you do content translation via gettext catalogs.
78 # Usually you set "language" from the command line for these cases.
81 # There are two options for replacing |today|: either, you set today to some
82 # non-false value, then it is used:
84 # Else, today_fmt is used as the format for a strftime call.
85 #today_fmt = '%B %d, %Y'
87 # List of patterns, relative to source directory, that match files and
88 # directories to ignore when looking for source files.
93 # The reST default role (used for this markup: `text`) to use for all
97 # If true, '()' will be appended to :func: etc. cross-reference text.
98 #add_function_parentheses = True
100 # If true, the current module name will be prepended to all description
101 # unit titles (such as .. function::).
102 #add_module_names = True
104 # If true, sectionauthor and moduleauthor directives will be shown in the
105 # output. They are ignored by default.
106 #show_authors = False
108 # The name of the Pygments (syntax highlighting) style to use.
109 pygments_style = 'sphinx'
111 # A list of ignored prefixes for module index sorting.
112 #modindex_common_prefix = []
114 # If true, keep warnings as "system message" paragraphs in the built documents.
115 #keep_warnings = False
117 # If true, `todo` and `todoList` produce output, else they produce nothing.
118 todo_include_todos = True
121 # -- Options for HTML output ----------------------------------------------
123 # The theme to use for HTML and HTML Help pages. See the documentation for
124 # a list of builtin themes.
125 html_theme = 'classic'
127 # Theme options are theme-specific and customize the look and feel of a theme
128 # further. For a list of options available for each theme, see the
130 #html_theme_options = {}
132 # Add any paths that contain custom themes here, relative to this directory.
133 #html_theme_path = []
135 # The name for this set of Sphinx documents. If None, it defaults to
136 # "<project> v<release> documentation".
139 # A shorter title for the navigation bar. Default is the same as html_title.
140 #html_short_title = None
142 # The name of an image file (relative to this directory) to place at the top
144 html_logo = '_static/logo_onap_2017.png'
146 # The name of an image file (within the static path) to use as favicon of the
147 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
149 html_favicon = '_static/favicon.ico'
151 # Add any paths that contain custom static files (such as style sheets) here,
152 # relative to this directory. They are copied after the builtin static files,
153 # so a file named "default.css" will overwrite the builtin "default.css".
154 html_static_path = ['_static']
156 # Add any extra paths that contain custom files (such as robots.txt or
157 # .htaccess) here, relative to this directory. These files are copied
158 # directly to the root of the documentation.
159 #html_extra_path = []
161 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
162 # using the given strftime format.
163 #html_last_updated_fmt = '%b %d, %Y'
165 # If true, SmartyPants will be used to convert quotes and dashes to
166 # typographically correct entities.
167 #html_use_smartypants = True
169 # Custom sidebar templates, maps document names to template names.
172 # Additional templates that should be rendered to pages, maps page names to
174 #html_additional_pages = {}
176 # If false, no module index is generated.
177 #html_domain_indices = True
179 # If false, no index is generated.
180 #html_use_index = True
182 # If true, the index is split into individual pages for each letter.
183 #html_split_index = False
185 # If true, links to the reST sources are added to the pages.
186 #html_show_sourcelink = True
188 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
189 #html_show_sphinx = True
191 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
192 #html_show_copyright = True
194 # If true, an OpenSearch description file will be output, and all pages will
195 # contain a <link> tag referring to it. The value of this option must be the
196 # base URL from which the finished HTML is served.
197 #html_use_opensearch = ''
199 # This is the file name suffix for HTML files (e.g. ".xhtml").
200 #html_file_suffix = None
202 # Language to be used for generating the HTML full-text search index.
203 # Sphinx supports the following languages:
204 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
205 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
206 #html_search_language = 'en'
208 # A dictionary with options for the search language support, empty by default.
209 # Now only 'ja' uses this config value
210 #html_search_options = {'type': 'default'}
212 # The name of a javascript file (relative to the configuration directory) that
213 # implements a search results scorer. If empty, the default will be used.
214 #html_search_scorer = 'scorer.js'
216 # Output file base name for HTML help builder.
217 htmlhelp_basename = 'ONAPdoc'
219 # -- Options for LaTeX output ---------------------------------------------
222 # The paper size ('letterpaper' or 'a4paper').
223 #'papersize': 'letterpaper',
225 # The font size ('10pt', '11pt' or '12pt').
226 #'pointsize': '10pt',
228 # Additional stuff for the LaTeX preamble.
231 # Latex figure (float) alignment
232 #'figure_align': 'htbp',
235 # Grouping the document tree into LaTeX files. List of tuples
236 # (source start file, target name, title,
237 # author, documentclass [howto, manual, or own class]).
239 (master_doc, 'ONAP.tex', u'ONAP Documentation',
240 u'ONAP Contributors', 'manual'),
243 # The name of an image file (relative to this directory) to place at the top of
247 # For "manual" documents, if this is true, then toplevel headings are parts,
249 #latex_use_parts = False
251 # If true, show page references after internal links.
252 #latex_show_pagerefs = False
254 # If true, show URL addresses after external links.
255 #latex_show_urls = False
257 # Documents to append as an appendix to all manuals.
258 #latex_appendices = []
260 # If false, no module index is generated.
261 #latex_domain_indices = True
264 # -- Options for manual page output ---------------------------------------
266 # One entry per manual page. List of tuples
267 # (source start file, name, description, authors, manual section).
269 (master_doc, 'onap', u'ONAP Documentation',
273 # If true, show URL addresses after external links.
274 #man_show_urls = False
277 # -- Options for Texinfo output -------------------------------------------
279 # Grouping the document tree into Texinfo files. List of tuples
280 # (source start file, target name, title, author,
281 # dir menu entry, description, category)
282 texinfo_documents = [
283 (master_doc, 'ONAP', u'ONAP Documentation',
284 author, 'ONAP', 'Open Network Automation Platform',
288 # Documents to append as an appendix to all manuals.
289 #texinfo_appendices = []
291 # If false, no module index is generated.
292 #texinfo_domain_indices = True
294 # How to display URL addresses: 'footnote', 'no', or 'inline'.
295 #texinfo_show_urls = 'footnote'
297 # If true, do not generate a @detailmenu in the "Top" node's menu.
298 #texinfo_no_detailmenu = False
301 # -- Options for Epub output ----------------------------------------------
303 # Bibliographic Dublin Core info.
306 epub_publisher = author
307 epub_copyright = copyright
309 # The basename for the epub file. It defaults to the project name.
310 #epub_basename = project
312 # The HTML theme for the epub output. Since the default themes are not optimized
313 # for small screen space, using the same theme for HTML and epub output is
314 # usually not wise. This defaults to 'epub', a theme designed to save visual
318 # The language of the text. It defaults to the language option
319 # or 'en' if the language is not set.
322 # The scheme of the identifier. Typical schemes are ISBN or URL.
325 # The unique identifier of the text. This can be a ISBN number
326 # or the project homepage.
327 #epub_identifier = ''
329 # A unique identification for the text.
332 # A tuple containing the cover image and cover page html template filenames.
335 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
338 # HTML files that should be inserted before the pages created by sphinx.
339 # The format is a list of tuples containing the path and title.
342 # HTML files shat should be inserted after the pages created by sphinx.
343 # The format is a list of tuples containing the path and title.
344 #epub_post_files = []
346 # A list of files that should not be packed into the epub file.
347 epub_exclude_files = ['search.html']
349 # The depth of the table of contents in toc.ncx.
352 # Allow duplicate toc entries.
355 # Choose between 'default' and 'includehidden'.
356 #epub_tocscope = 'default'
358 # Fix unsupported image types using the Pillow.
359 #epub_fix_images = False
361 # Scale large images.
362 #epub_max_image_width = 0
364 # How to display URL addresses: 'footnote', 'no', or 'inline'.
365 #epub_show_urls = 'inline'
367 # If false, no index is generated.
368 #epub_use_index = True
370 # Patterns to ignore in linkcheck builder
371 linkcheck_ignore = [r'http://localhost:\d+/']