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_bootstrap_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.nwdiag',
42 'sphinxcontrib.seqdiag',
43 'sphinx.ext.ifconfig',
45 'sphinxcontrib.plantuml',
46 'sphinxcontrib.swaggerdoc'
49 # Font path for seqdiag
50 seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
51 nwdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
53 # Add any paths that contain templates here, relative to this directory.
54 templates_path = ['_templates']
56 # The suffix(es) of source filenames.
57 # You can specify multiple suffix as a list of string:
58 # source_suffix = ['.rst', '.md']
59 source_suffix = '.rst'
61 # The encoding of source files.
62 #source_encoding = 'utf-8-sig'
64 # The master toctree document.
67 # General information about the project.
69 copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
72 author = u'Open Network Automation Platform'
74 # The version info for the project you're documenting, acts as replacement for
75 # |version| and |release|, also used in various other places throughout the
77 # The short X.Y version.
78 version = 'master branch'
79 # The full version, including alpha/beta/rc tags.
80 release = 'master branch'
82 # The language for content autogenerated by Sphinx. Refer to documentation
83 # for a list of supported languages.
85 # This is also used if you do content translation via gettext catalogs.
86 # Usually you set "language" from the command line for these cases.
89 # There are two options for replacing |today|: either, you set today to some
90 # non-false value, then it is used:
92 # Else, today_fmt is used as the format for a strftime call.
93 #today_fmt = '%B %d, %Y'
95 # List of patterns, relative to source directory, that match files and
96 # directories to ignore when looking for source files.
101 # The reST default role (used for this markup: `text`) to use for all
105 # If true, '()' will be appended to :func: etc. cross-reference text.
106 #add_function_parentheses = True
108 # If true, the current module name will be prepended to all description
109 # unit titles (such as .. function::).
110 #add_module_names = True
112 # If true, sectionauthor and moduleauthor directives will be shown in the
113 # output. They are ignored by default.
114 #show_authors = False
116 # The name of the Pygments (syntax highlighting) style to use.
117 pygments_style = 'sphinx'
119 # A list of ignored prefixes for module index sorting.
120 #modindex_common_prefix = []
122 # If true, keep warnings as "system message" paragraphs in the built documents.
123 #keep_warnings = False
125 # If true, `todo` and `todoList` produce output, else they produce nothing.
126 todo_include_todos = True
129 # -- Options for HTML output ----------------------------------------------
131 # The theme to use for HTML and HTML Help pages. See the documentation for
132 # a list of builtin themes.
133 #html_theme = 'bootstrap'
134 html_theme = 'classic'
136 # Theme options are theme-specific and customize the look and feel of a theme
137 # further. For a list of options available for each theme, see the
139 #html_theme_options = {}
141 # Add any paths that contain custom themes here, relative to this directory.
142 #html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
144 # The name for this set of Sphinx documents. If None, it defaults to
145 # "<project> v<release> documentation".
148 # A shorter title for the navigation bar. Default is the same as html_title.
149 #html_short_title = None
151 # The name of an image file (relative to this directory) to place at the top
153 html_logo = '_static/logo_onap_2017.png'
155 # The name of an image file (within the static path) to use as favicon of the
156 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
158 html_favicon = '_static/favicon.ico'
160 # Add any paths that contain custom static files (such as style sheets) here,
161 # relative to this directory. They are copied after the builtin static files,
162 # so a file named "default.css" will overwrite the builtin "default.css".
163 html_static_path = ['_static']
165 # Add any extra paths that contain custom files (such as robots.txt or
166 # .htaccess) here, relative to this directory. These files are copied
167 # directly to the root of the documentation.
168 #html_extra_path = []
170 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
171 # using the given strftime format.
172 html_last_updated_fmt = '%d-%b-%y %H:%M'
174 # If true, SmartyPants will be used to convert quotes and dashes to
175 # typographically correct entities.
176 #html_use_smartypants = True
178 # Custom sidebar templates, maps document names to template names.
181 # Additional templates that should be rendered to pages, maps page names to
183 #html_additional_pages = {}
185 # If false, no module index is generated.
186 #html_domain_indices = True
188 # If false, no index is generated.
189 #html_use_index = True
191 # If true, the index is split into individual pages for each letter.
192 #html_split_index = False
194 # If true, links to the reST sources are added to the pages.
195 #html_show_sourcelink = True
197 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
198 html_show_sphinx = False
200 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
201 #html_show_copyright = True
203 # If true, an OpenSearch description file will be output, and all pages will
204 # contain a <link> tag referring to it. The value of this option must be the
205 # base URL from which the finished HTML is served.
206 #html_use_opensearch = ''
208 # This is the file name suffix for HTML files (e.g. ".xhtml").
209 #html_file_suffix = None
211 # Language to be used for generating the HTML full-text search index.
212 # Sphinx supports the following languages:
213 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
214 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
215 #html_search_language = 'en'
217 # A dictionary with options for the search language support, empty by default.
218 # Now only 'ja' uses this config value
219 #html_search_options = {'type': 'default'}
221 # The name of a javascript file (relative to the configuration directory) that
222 # implements a search results scorer. If empty, the default will be used.
223 #html_search_scorer = 'scorer.js'
225 # Output file base name for HTML help builder.
226 htmlhelp_basename = 'ONAPdoc'
228 # -- Options for LaTeX output ---------------------------------------------
231 # The paper size ('letterpaper' or 'a4paper').
232 #'papersize': 'letterpaper',
234 # The font size ('10pt', '11pt' or '12pt').
235 #'pointsize': '10pt',
237 # Additional stuff for the LaTeX preamble.
240 # Latex figure (float) alignment
241 #'figure_align': 'htbp',
244 # Grouping the document tree into LaTeX files. List of tuples
245 # (source start file, target name, title,
246 # author, documentclass [howto, manual, or own class]).
248 (master_doc, 'ONAP.tex', u'ONAP Documentation',
249 u'ONAP Contributors', 'manual'),
252 # The name of an image file (relative to this directory) to place at the top of
256 # For "manual" documents, if this is true, then toplevel headings are parts,
258 #latex_use_parts = False
260 # If true, show page references after internal links.
261 #latex_show_pagerefs = False
263 # If true, show URL addresses after external links.
264 #latex_show_urls = False
266 # Documents to append as an appendix to all manuals.
267 #latex_appendices = []
269 # If false, no module index is generated.
270 #latex_domain_indices = True
273 # -- Options for manual page output ---------------------------------------
275 # One entry per manual page. List of tuples
276 # (source start file, name, description, authors, manual section).
278 (master_doc, 'onap', u'ONAP Documentation',
282 # If true, show URL addresses after external links.
283 #man_show_urls = False
286 # -- Options for Texinfo output -------------------------------------------
288 # Grouping the document tree into Texinfo files. List of tuples
289 # (source start file, target name, title, author,
290 # dir menu entry, description, category)
291 texinfo_documents = [
292 (master_doc, 'ONAP', u'ONAP Documentation',
293 author, 'ONAP', 'Open Network Automation Platform',
297 # Documents to append as an appendix to all manuals.
298 #texinfo_appendices = []
300 # If false, no module index is generated.
301 #texinfo_domain_indices = True
303 # How to display URL addresses: 'footnote', 'no', or 'inline'.
304 #texinfo_show_urls = 'footnote'
306 # If true, do not generate a @detailmenu in the "Top" node's menu.
307 #texinfo_no_detailmenu = False
310 # -- Options for Epub output ----------------------------------------------
312 # Bibliographic Dublin Core info.
315 epub_publisher = author
316 epub_copyright = copyright
318 # The basename for the epub file. It defaults to the project name.
319 #epub_basename = project
321 # The HTML theme for the epub output. Since the default themes are not optimized
322 # for small screen space, using the same theme for HTML and epub output is
323 # usually not wise. This defaults to 'epub', a theme designed to save visual
327 # The language of the text. It defaults to the language option
328 # or 'en' if the language is not set.
331 # The scheme of the identifier. Typical schemes are ISBN or URL.
334 # The unique identifier of the text. This can be a ISBN number
335 # or the project homepage.
336 #epub_identifier = ''
338 # A unique identification for the text.
341 # A tuple containing the cover image and cover page html template filenames.
344 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
347 # HTML files that should be inserted before the pages created by sphinx.
348 # The format is a list of tuples containing the path and title.
351 # HTML files shat should be inserted after the pages created by sphinx.
352 # The format is a list of tuples containing the path and title.
353 #epub_post_files = []
355 # A list of files that should not be packed into the epub file.
356 epub_exclude_files = ['search.html']
358 # The depth of the table of contents in toc.ncx.
361 # Allow duplicate toc entries.
364 # Choose between 'default' and 'includehidden'.
365 #epub_tocscope = 'default'
367 # Fix unsupported image types using the Pillow.
368 #epub_fix_images = False
370 # Scale large images.
371 #epub_max_image_width = 0
373 # How to display URL addresses: 'footnote', 'no', or 'inline'.
374 #epub_show_urls = 'inline'
376 # If false, no index is generated.
377 #epub_use_index = True
379 # Patterns to ignore in linkcheck builder
382 r'http://yourhostname',
383 r'http://{PDP_URL}:\d+/',
384 r'http://.*simpledemo.onap.org:\d+/',
385 r'http://load-balanced-address:\d+/',
387 r'http://ESR_SERVER_IP:\d+/',
388 r'http://MSB_SERVER_IP:\d+/',
389 r'http://msb_docker_host_ip:\d+/',
390 r'http://msb.onap.org/',
391 r'http://\$msb_address/',
392 r'http://hostIP:\d+/',
393 r'https://\$CBAM_IP:\d+/',
394 r'http://app-host:port/',
395 r'http://servername.domain.com',
396 r'https://we-are-message-router.us:\d+/',
397 r'https://we-are-data-router.us:\d+/',
398 r'http://prov.datarouternew.com:8443/',
399 r'http://www.[host]:[port]/',
404 r'http://app-host:port/'