Update git submodules
[doc.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # ONAP documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jul 19 16:25:31 2017.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 import sys
16 import os
17 import shlex
18 #import sphinx_bootstrap_theme
19
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('.'))
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 needs_sphinx = '1.5.3'
29
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 # ones.
33 extensions = [
34     'sphinx.ext.autodoc',
35     'sphinx.ext.doctest',
36     'sphinx.ext.graphviz',
37     'sphinx.ext.todo',
38     'sphinx.ext.imgmath',
39     'sphinx.ext.viewcode',
40     'sphinxcontrib.blockdiag',
41     'sphinxcontrib.needs',
42     'sphinxcontrib.nwdiag',
43     'sphinxcontrib.seqdiag',
44     'sphinx.ext.ifconfig',
45     'sphinx.ext.todo',
46     'sphinxcontrib.plantuml',
47     'sphinxcontrib.swaggerdoc'
48 ]
49
50 # Font path for seqdiag
51 seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
52 nwdiag_fontpath =  '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
53
54 # Add any paths that contain templates here, relative to this directory.
55 templates_path = ['_templates']
56
57 # The suffix(es) of source filenames.
58 # You can specify multiple suffix as a list of string:
59 # source_suffix = ['.rst', '.md']
60 source_suffix = '.rst'
61
62 # The encoding of source files.
63 #source_encoding = 'utf-8-sig'
64
65 # The master toctree document.
66 master_doc = 'index'
67
68 # General information about the project.
69 project = u''
70 copyright = u'2019 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
71
72
73 author = u'Open Network Automation Platform'
74
75 # The version info for the project you're documenting, acts as replacement for
76 # |version| and |release|, also used in various other places throughout the
77 # built documents.
78 # The short X.Y version.
79 version = 'master branch'
80 # The full version, including alpha/beta/rc tags.
81 release = 'master branch'
82
83 # The language for content autogenerated by Sphinx. Refer to documentation
84 # for a list of supported languages.
85 #
86 # This is also used if you do content translation via gettext catalogs.
87 # Usually you set "language" from the command line for these cases.
88 language = None
89
90 # There are two options for replacing |today|: either, you set today to some
91 # non-false value, then it is used:
92 #today = ''
93 # Else, today_fmt is used as the format for a strftime call.
94 #today_fmt = '%B %d, %Y'
95
96 # List of patterns, relative to source directory, that match files and
97 # directories to ignore when looking for source files.
98 exclude_patterns = [
99         '_build'
100         ]
101
102 # The reST default role (used for this markup: `text`) to use for all
103 # documents.
104 #default_role = None
105
106 # If true, '()' will be appended to :func: etc. cross-reference text.
107 #add_function_parentheses = True
108
109 # If true, the current module name will be prepended to all description
110 # unit titles (such as .. function::).
111 #add_module_names = True
112
113 # If true, sectionauthor and moduleauthor directives will be shown in the
114 # output. They are ignored by default.
115 #show_authors = False
116
117 # The name of the Pygments (syntax highlighting) style to use.
118 pygments_style = 'sphinx'
119
120 # A list of ignored prefixes for module index sorting.
121 #modindex_common_prefix = []
122
123 # If true, keep warnings as "system message" paragraphs in the built documents.
124 keep_warnings = True
125
126 # If true, `todo` and `todoList` produce output, else they produce nothing.
127 todo_include_todos = True
128
129
130 # -- Options for HTML output ----------------------------------------------
131
132 # The theme to use for HTML and HTML Help pages.  See the documentation for
133 # a list of builtin themes.
134 #html_theme = 'classic'
135 html_theme = 'sphinx_rtd_theme'
136
137 # Theme options are theme-specific and customize the look and feel of a theme
138 # further.  For a list of options available for each theme, see the
139 # documentation.
140 html_theme_options = {
141         'style_nav_header_background': 'white',
142         'sticky_navigation': False
143         }
144
145 # Add any paths that contain custom themes here, relative to this directory.
146 #html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
147
148 # The name for this set of Sphinx documents.  If None, it defaults to
149 # "<project> v<release> documentation".
150 #html_title = None
151
152 # A shorter title for the navigation bar.  Default is the same as html_title.
153 #html_short_title = None
154
155 # The name of an image file (relative to this directory) to place at the top
156 # of the sidebar.
157 html_logo = '_static/logo_onap_2017.png'
158
159 # The name of an image file (within the static path) to use as favicon of the
160 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
161 # pixels large.
162 html_favicon = '_static/favicon.ico'
163
164 # Add any paths that contain custom static files (such as style sheets) here,
165 # relative to this directory. They are copied after the builtin static files,
166 # so a file named "default.css" will overwrite the builtin "default.css".
167 html_static_path = ['_static']
168
169 # Add any extra paths that contain custom files (such as robots.txt or
170 # .htaccess) here, relative to this directory. These files are copied
171 # directly to the root of the documentation.
172 #html_extra_path = []
173
174 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
175 # using the given strftime format.
176 html_last_updated_fmt = '%d-%b-%y %H:%M'
177
178 # If true, SmartyPants will be used to convert quotes and dashes to
179 # typographically correct entities.
180 #html_use_smartypants = True
181
182 # Custom sidebar templates, maps document names to template names.
183 #html_sidebars = {}
184
185 # Additional templates that should be rendered to pages, maps page names to
186 # template names.
187 #html_additional_pages = {}
188
189 # If false, no module index is generated.
190 #html_domain_indices = True
191
192 # If false, no index is generated.
193 #html_use_index = True
194
195 # If true, the index is split into individual pages for each letter.
196 #html_split_index = False
197
198 # If true, links to the reST sources are added to the pages.
199 #html_show_sourcelink = True
200
201 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
202 html_show_sphinx = False
203
204 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
205 #html_show_copyright = True
206
207 # If true, an OpenSearch description file will be output, and all pages will
208 # contain a <link> tag referring to it.  The value of this option must be the
209 # base URL from which the finished HTML is served.
210 #html_use_opensearch = ''
211
212 # This is the file name suffix for HTML files (e.g. ".xhtml").
213 #html_file_suffix = None
214
215 # Language to be used for generating the HTML full-text search index.
216 # Sphinx supports the following languages:
217 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
218 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
219 #html_search_language = 'en'
220
221 # A dictionary with options for the search language support, empty by default.
222 # Now only 'ja' uses this config value
223 #html_search_options = {'type': 'default'}
224
225 # The name of a javascript file (relative to the configuration directory) that
226 # implements a search results scorer. If empty, the default will be used.
227 #html_search_scorer = 'scorer.js'
228
229 # Output file base name for HTML help builder.
230 htmlhelp_basename = 'ONAPdoc'
231
232 # -- Options for LaTeX output ---------------------------------------------
233
234 latex_elements = {
235 # The paper size ('letterpaper' or 'a4paper').
236 #'papersize': 'letterpaper',
237
238 # The font size ('10pt', '11pt' or '12pt').
239 #'pointsize': '10pt',
240
241 # Additional stuff for the LaTeX preamble.
242 #'preamble': '',
243
244 # Latex figure (float) alignment
245 #'figure_align': 'htbp',
246 }
247
248 # Grouping the document tree into LaTeX files. List of tuples
249 # (source start file, target name, title,
250 #  author, documentclass [howto, manual, or own class]).
251 latex_documents = [
252   (master_doc, 'ONAP.tex', u'ONAP Documentation',
253    u'ONAP Contributors', 'manual'),
254 ]
255
256 # The name of an image file (relative to this directory) to place at the top of
257 # the title page.
258 #latex_logo = None
259
260 # For "manual" documents, if this is true, then toplevel headings are parts,
261 # not chapters.
262 #latex_use_parts = False
263
264 # If true, show page references after internal links.
265 #latex_show_pagerefs = False
266
267 # If true, show URL addresses after external links.
268 #latex_show_urls = False
269
270 # Documents to append as an appendix to all manuals.
271 #latex_appendices = []
272
273 # If false, no module index is generated.
274 #latex_domain_indices = True
275
276
277 # -- Options for manual page output ---------------------------------------
278
279 # One entry per manual page. List of tuples
280 # (source start file, name, description, authors, manual section).
281 man_pages = [
282     (master_doc, 'onap', u'ONAP Documentation',
283      [author], 1)
284 ]
285
286 # If true, show URL addresses after external links.
287 #man_show_urls = False
288
289
290 # -- Options for Texinfo output -------------------------------------------
291
292 # Grouping the document tree into Texinfo files. List of tuples
293 # (source start file, target name, title, author,
294 #  dir menu entry, description, category)
295 texinfo_documents = [
296   (master_doc, 'ONAP', u'ONAP Documentation',
297    author, 'ONAP', 'Open Network Automation Platform',
298    'Platform'),
299 ]
300
301 # Documents to append as an appendix to all manuals.
302 #texinfo_appendices = []
303
304 # If false, no module index is generated.
305 #texinfo_domain_indices = True
306
307 # How to display URL addresses: 'footnote', 'no', or 'inline'.
308 #texinfo_show_urls = 'footnote'
309
310 # If true, do not generate a @detailmenu in the "Top" node's menu.
311 #texinfo_no_detailmenu = False
312
313
314 # -- Options for Epub output ----------------------------------------------
315
316 # Bibliographic Dublin Core info.
317 epub_title = project
318 epub_author = author
319 epub_publisher = author
320 epub_copyright = copyright
321
322 # The basename for the epub file. It defaults to the project name.
323 #epub_basename = project
324
325 # The HTML theme for the epub output. Since the default themes are not optimized
326 # for small screen space, using the same theme for HTML and epub output is
327 # usually not wise. This defaults to 'epub', a theme designed to save visual
328 # space.
329 #epub_theme = 'epub'
330
331 # The language of the text. It defaults to the language option
332 # or 'en' if the language is not set.
333 #epub_language = ''
334
335 # The scheme of the identifier. Typical schemes are ISBN or URL.
336 #epub_scheme = ''
337
338 # The unique identifier of the text. This can be a ISBN number
339 # or the project homepage.
340 #epub_identifier = ''
341
342 # A unique identification for the text.
343 #epub_uid = ''
344
345 # A tuple containing the cover image and cover page html template filenames.
346 #epub_cover = ()
347
348 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
349 #epub_guide = ()
350
351 # HTML files that should be inserted before the pages created by sphinx.
352 # The format is a list of tuples containing the path and title.
353 #epub_pre_files = []
354
355 # HTML files shat should be inserted after the pages created by sphinx.
356 # The format is a list of tuples containing the path and title.
357 #epub_post_files = []
358
359 # A list of files that should not be packed into the epub file.
360 epub_exclude_files = ['search.html']
361
362 # The depth of the table of contents in toc.ncx.
363 #epub_tocdepth = 3
364
365 # Allow duplicate toc entries.
366 #epub_tocdup = True
367
368 # Choose between 'default' and 'includehidden'.
369 #epub_tocscope = 'default'
370
371 # Fix unsupported image types using the Pillow.
372 #epub_fix_images = False
373
374 # Scale large images.
375 #epub_max_image_width = 0
376
377 # How to display URL addresses: 'footnote', 'no', or 'inline'.
378 #epub_show_urls = 'inline'
379
380 # If false, no index is generated.
381 #epub_use_index = True
382
383 # Patterns to ignore in linkcheck builder
384 linkcheck_ignore = [
385         r'http://$',
386         r'http:/$',
387         r'http://10\.',
388         r'http://127\.',
389         r'http://172\.[123]',
390         r'http://app_host:port/',
391         r'http://app-host:port/',
392         r'http://ESR_SERVICE_IP',
393         r'http://ESR_SERVER_IP',
394         r'http://hostIP:\d+/',
395         r'http://load-balanced-address:\d+/',
396         r'http://localhost',
397         r'http://\$msb_address/',
398         r'http://\$MSB_SERVER_IP:\d+/',
399         r'http://msb_docker_host_ip:\d+/',
400         r'http://MSB_IP:MSB_PORT/',
401         r'http://msb.onap.org',
402         r'http://MSB_SERVER_IP:\d+/',
403         r'http://org.openecomp.',
404         r'http://{PDP_URL}:\d+/',
405         r'http://servername.domain.com',
406         r'http://.*simpledemo.openecomp.org',
407         r'http://.*simpledemo.onap.org',
408         r'http://.*test.att.com:\d+/',
409         r'http://we-are-data-router.us',
410         r'http://we-are-message-router.us:\d+/'
411         r'http://www.\[host\]:\[port\]/',
412         r'http://yourhostname',
413         r'https://$',
414         r'https:/$',
415         r'https://10\.',
416         r'https://127\.',
417         r'https://172\.[123]',
418         r'https://aaf.onap.org',
419         r'https://\$CBAM_IP',
420         r'https://ESR_SERVICE_IP',
421         r'https://ESR_SERVER_IP',
422         r'https://msb.onap.org',
423         r'https://my-subscriber-app.dcae',
424         r'https://\$CBAM_IP:\d+/',
425         r'https://load-balanced-address:\d+/',
426         r'https://prov.datarouternew.com:8443',
427         r'https://.*simpledemo.openecomp.org',
428         r'https://.*simpledemo.onap.org',
429         r'https://.*test.att.com:\d+/',
430         r'https://we-are-data-router.us',
431         r'https://we-are-message-router.us:\d+/'
432         ]
433
434 from docutils.parsers.rst import directives
435
436 needs_extra_options = {
437     "target": directives.unchanged,
438     "keyword": directives.unchanged,
439     "introduced": directives.unchanged,
440     "updated": directives.unchanged,
441     "impacts": directives.unchanged,
442     "validation_mode": directives.unchanged,
443     "validated_by": directives.unchanged,
444     "test": directives.unchanged,
445     "test_case": directives.unchanged,
446     "test_file": directives.unchanged,
447     "notes": directives.unchanged,
448 }
449
450 needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+"
451 needs_id_required = True
452 needs_title_optional = True
453
454 needs_template_collapse = """
455 .. _{{id}}:
456
457 {% if hide == false -%}
458 .. role:: needs_tag
459 .. role:: needs_status
460 .. role:: needs_type
461 .. role:: needs_id
462 .. role:: needs_title
463
464 .. rst-class:: need
465 .. rst-class:: need_{{type_name}}
466
467 .. container:: need
468
469     `{{id}}` - {{content|indent(4)}}
470
471     .. container:: toggle
472
473         .. container:: header
474
475             Details
476
477 {% if status and  status|upper != "NONE" and not hide_status %}        | status: :needs_status:`{{status}}`{% endif %}
478 {% if tags and not hide_tags %}        | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %}
479 {% if keyword %}        | keyword: `{{keyword}}` {% endif %}
480 {% if target %}        | target: `{{target}}` {% endif %}
481 {% if introduced %}        | introduced: `{{introduced}}` {% endif %}
482 {% if updated %}        | updated: `{{updated}}` {% endif %}
483 {% if impacts %}        | impacts: `{{impacts}}` {% endif %}
484 {% if validation_mode %}        | validation mode: `{{validation_mode}}` {% endif %}
485 {% if validated_by %}        | validated by: `{{validated_by}}` {% endif %}
486 {% if test %}        | test: `{{test}}` {% endif %}
487 {% if test_case %}        | test case: {{test_case}} {% endif %}
488 {% if test_file %}        | test file: `{{test_file}}` {% endif %}
489 {% if notes %}        | notes: `{{notes}}` {% endif %}
490         | children: :need_incoming:`{{id}}`
491         | parents: :need_outgoing:`{{id}}`
492 {% endif -%}
493 """
494
495 def setup(app):
496     app.add_stylesheet("css/ribbon.css")