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.
18 import sphinx_rtd_theme
20 # If extensions (or modules to document with autodoc) are in another directory,
21 # add these directories to sys.path here. If the directory is relative to the
22 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 #sys.path.insert(0, os.path.abspath('.'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
28 needs_sphinx = '1.5.3'
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 'sphinx.ext.graphviz',
39 'sphinx.ext.viewcode',
40 'sphinxcontrib.blockdiag',
41 'sphinxcontrib.seqdiag',
42 'sphinx.ext.ifconfig',
44 'sphinxcontrib.httpdomain',
45 'sphinxcontrib.plantuml',
46 'sphinxcontrib.swaggerdoc'
49 # Font path for seqdiag
50 seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
52 # Add any paths that contain templates here, relative to this directory.
53 templates_path = ['_templates']
55 # The suffix(es) of source filenames.
56 # You can specify multiple suffix as a list of string:
57 # source_suffix = ['.rst', '.md']
58 source_suffix = '.rst'
60 # The encoding of source files.
61 #source_encoding = 'utf-8-sig'
63 # The master toctree document.
66 # General information about the project.
68 copyright = u'2017, ONAP Contributors'
69 author = u'ONAP Contributors'
71 # The version info for the project you're documenting, acts as replacement for
72 # |version| and |release|, also used in various other places throughout the
75 # The short X.Y version.
76 version = 'pre-release alpha'
77 # The full version, including alpha/beta/rc tags.
78 release = 'Amsterdam 0.1 alpha'
80 # The language for content autogenerated by Sphinx. Refer to documentation
81 # for a list of supported languages.
83 # This is also used if you do content translation via gettext catalogs.
84 # Usually you set "language" from the command line for these cases.
87 # There are two options for replacing |today|: either, you set today to some
88 # non-false value, then it is used:
90 # Else, today_fmt is used as the format for a strftime call.
91 #today_fmt = '%B %d, %Y'
93 # List of patterns, relative to source directory, that match files and
94 # directories to ignore when looking for source files.
99 # The reST default role (used for this markup: `text`) to use for all
103 # If true, '()' will be appended to :func: etc. cross-reference text.
104 #add_function_parentheses = True
106 # If true, the current module name will be prepended to all description
107 # unit titles (such as .. function::).
108 #add_module_names = True
110 # If true, sectionauthor and moduleauthor directives will be shown in the
111 # output. They are ignored by default.
112 #show_authors = False
114 # The name of the Pygments (syntax highlighting) style to use.
115 pygments_style = 'sphinx'
117 # A list of ignored prefixes for module index sorting.
118 #modindex_common_prefix = []
120 # If true, keep warnings as "system message" paragraphs in the built documents.
121 #keep_warnings = False
123 # If true, `todo` and `todoList` produce output, else they produce nothing.
124 todo_include_todos = True
127 # -- Options for HTML output ----------------------------------------------
129 # The theme to use for HTML and HTML Help pages. See the documentation for
130 # a list of builtin themes.
131 #html_theme = 'classic'
132 html_theme = 'sphinx_rtd_theme'
133 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
135 # Theme options are theme-specific and customize the look and feel of a theme
136 # further. For a list of options available for each theme, see the
138 #html_theme_options = {}
140 # Add any paths that contain custom themes here, relative to this directory.
141 #html_theme_path = []
143 # The name for this set of Sphinx documents. If None, it defaults to
144 # "<project> v<release> documentation".
147 # A shorter title for the navigation bar. Default is the same as html_title.
148 #html_short_title = None
150 # The name of an image file (relative to this directory) to place at the top
152 html_logo = '_static/logo_onap_2017.png'
154 # The name of an image file (within the static path) to use as favicon of the
155 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
157 html_favicon = '_static/favicon.ico'
159 # Add any paths that contain custom static files (such as style sheets) here,
160 # relative to this directory. They are copied after the builtin static files,
161 # so a file named "default.css" will overwrite the builtin "default.css".
162 html_static_path = ['_static']
164 # Add any extra paths that contain custom files (such as robots.txt or
165 # .htaccess) here, relative to this directory. These files are copied
166 # directly to the root of the documentation.
167 #html_extra_path = []
169 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
170 # using the given strftime format.
171 #html_last_updated_fmt = '%b %d, %Y'
173 # If true, SmartyPants will be used to convert quotes and dashes to
174 # typographically correct entities.
175 #html_use_smartypants = True
177 # Custom sidebar templates, maps document names to template names.
180 # Additional templates that should be rendered to pages, maps page names to
182 #html_additional_pages = {}
184 # If false, no module index is generated.
185 #html_domain_indices = True
187 # If false, no index is generated.
188 #html_use_index = True
190 # If true, the index is split into individual pages for each letter.
191 #html_split_index = False
193 # If true, links to the reST sources are added to the pages.
194 #html_show_sourcelink = True
196 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
197 #html_show_sphinx = True
199 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
200 #html_show_copyright = True
202 # If true, an OpenSearch description file will be output, and all pages will
203 # contain a <link> tag referring to it. The value of this option must be the
204 # base URL from which the finished HTML is served.
205 #html_use_opensearch = ''
207 # This is the file name suffix for HTML files (e.g. ".xhtml").
208 #html_file_suffix = None
210 # Language to be used for generating the HTML full-text search index.
211 # Sphinx supports the following languages:
212 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
213 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
214 #html_search_language = 'en'
216 # A dictionary with options for the search language support, empty by default.
217 # Now only 'ja' uses this config value
218 #html_search_options = {'type': 'default'}
220 # The name of a javascript file (relative to the configuration directory) that
221 # implements a search results scorer. If empty, the default will be used.
222 #html_search_scorer = 'scorer.js'
224 # Output file base name for HTML help builder.
225 htmlhelp_basename = 'ONAPdoc'
227 # -- Options for LaTeX output ---------------------------------------------
230 # The paper size ('letterpaper' or 'a4paper').
231 #'papersize': 'letterpaper',
233 # The font size ('10pt', '11pt' or '12pt').
234 #'pointsize': '10pt',
236 # Additional stuff for the LaTeX preamble.
239 # Latex figure (float) alignment
240 #'figure_align': 'htbp',
243 # Grouping the document tree into LaTeX files. List of tuples
244 # (source start file, target name, title,
245 # author, documentclass [howto, manual, or own class]).
247 (master_doc, 'ONAP.tex', u'ONAP Documentation',
248 u'ONAP Contributors', 'manual'),
251 # The name of an image file (relative to this directory) to place at the top of
255 # For "manual" documents, if this is true, then toplevel headings are parts,
257 #latex_use_parts = False
259 # If true, show page references after internal links.
260 #latex_show_pagerefs = False
262 # If true, show URL addresses after external links.
263 #latex_show_urls = False
265 # Documents to append as an appendix to all manuals.
266 #latex_appendices = []
268 # If false, no module index is generated.
269 #latex_domain_indices = True
272 # -- Options for manual page output ---------------------------------------
274 # One entry per manual page. List of tuples
275 # (source start file, name, description, authors, manual section).
277 (master_doc, 'onap', u'ONAP Documentation',
281 # If true, show URL addresses after external links.
282 #man_show_urls = False
285 # -- Options for Texinfo output -------------------------------------------
287 # Grouping the document tree into Texinfo files. List of tuples
288 # (source start file, target name, title, author,
289 # dir menu entry, description, category)
290 texinfo_documents = [
291 (master_doc, 'ONAP', u'ONAP Documentation',
292 author, 'ONAP', 'Open Network Automation Platform',
296 # Documents to append as an appendix to all manuals.
297 #texinfo_appendices = []
299 # If false, no module index is generated.
300 #texinfo_domain_indices = True
302 # How to display URL addresses: 'footnote', 'no', or 'inline'.
303 #texinfo_show_urls = 'footnote'
305 # If true, do not generate a @detailmenu in the "Top" node's menu.
306 #texinfo_no_detailmenu = False
309 # -- Options for Epub output ----------------------------------------------
311 # Bibliographic Dublin Core info.
314 epub_publisher = author
315 epub_copyright = copyright
317 # The basename for the epub file. It defaults to the project name.
318 #epub_basename = project
320 # The HTML theme for the epub output. Since the default themes are not optimized
321 # for small screen space, using the same theme for HTML and epub output is
322 # usually not wise. This defaults to 'epub', a theme designed to save visual
326 # The language of the text. It defaults to the language option
327 # or 'en' if the language is not set.
330 # The scheme of the identifier. Typical schemes are ISBN or URL.
333 # The unique identifier of the text. This can be a ISBN number
334 # or the project homepage.
335 #epub_identifier = ''
337 # A unique identification for the text.
340 # A tuple containing the cover image and cover page html template filenames.
343 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
346 # HTML files that should be inserted before the pages created by sphinx.
347 # The format is a list of tuples containing the path and title.
350 # HTML files shat should be inserted after the pages created by sphinx.
351 # The format is a list of tuples containing the path and title.
352 #epub_post_files = []
354 # A list of files that should not be packed into the epub file.
355 epub_exclude_files = ['search.html']
357 # The depth of the table of contents in toc.ncx.
360 # Allow duplicate toc entries.
363 # Choose between 'default' and 'includehidden'.
364 #epub_tocscope = 'default'
366 # Fix unsupported image types using the Pillow.
367 #epub_fix_images = False
369 # Scale large images.
370 #epub_max_image_width = 0
372 # How to display URL addresses: 'footnote', 'no', or 'inline'.
373 #epub_show_urls = 'inline'
375 # If false, no index is generated.
376 #epub_use_index = True
378 # Patterns to ignore in linkcheck builder
379 linkcheck_ignore = [r'http://localhost:\d+/']