diff options
Diffstat (limited to 'docs')
40 files changed, 4 insertions, 381 deletions
diff --git a/docs/conf2.py b/docs/conf2.py deleted file mode 100644 index 1cb86543f..000000000 --- a/docs/conf2.py +++ /dev/null @@ -1,379 +0,0 @@ -# -*- coding: utf-8 -*- -# -# ONAP documentation build configuration file, created by -# sphinx-quickstart on Wed Jul 19 16:25:31 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex -import sphinx_bootstrap_theme - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.5.3' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.graphviz', - 'sphinx.ext.todo', - 'sphinx.ext.imgmath', - 'sphinx.ext.viewcode', - 'sphinxcontrib.blockdiag', - 'sphinxcontrib.seqdiag', - 'sphinx.ext.ifconfig', - 'sphinx.ext.todo', - 'sphinxcontrib.httpdomain', - 'sphinxcontrib.plantuml', - 'sphinxcontrib.swaggerdoc' -] - -# Font path for seqdiag -seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'' -copyright = u'2017, ONAP. Licensed under CC BY 4.0' -author = u'Open Network Automation Platform' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = 'Latest' -# The full version, including alpha/beta/rc tags. -release = 'Latest' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [ - '_build' - ] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'bootstrap' -#html_theme = 'classic' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = '_static/logo_onap_2017.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -html_favicon = '_static/favicon.ico' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'ONAPdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'ONAP.tex', u'ONAP Documentation', - u'ONAP Contributors', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'onap', u'ONAP Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'ONAP', u'ONAP Documentation', - author, 'ONAP', 'Open Network Automation Platform', - 'Platform'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -#epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not optimized -# for small screen space, using the same theme for HTML and epub output is -# usually not wise. This defaults to 'epub', a theme designed to save visual -# space. -#epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -#epub_fix_images = False - -# Scale large images. -#epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' - -# If false, no index is generated. -#epub_use_index = True - -# Patterns to ignore in linkcheck builder -linkcheck_ignore = [r'http://localhost:\d+/'] - diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 35c833cf9..896c23170 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -492,11 +492,13 @@ Build documentation using tox local environment & then open using any browser. firefox docs/_build/html/index.html .. note:: Make sure to run `tox -elocal` and not just `tox`. + This updates all submodule repositories that are integrated + by the doc project. There are additional tox environment options for checking External URLs and Spelling. Use the tox environment options below and then -look at the output with the Linux `more` or similar command for -scanning for output that applies to the files you are validating. +look at the output with the Linux `more` or similar command +scan for output that applies to the files you are validating. .. code-block:: bash diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject a50007dcded86acc2dcd610810f8afac720a058 +Subproject da6154df2951bbdedea753f588d41153e3582ef diff --git a/docs/submodules/aai/esr-gui.git b/docs/submodules/aai/esr-gui.git -Subproject 12a890ceed8c6ae96b9c5eafad942a24bb68d50 +Subproject 4ee81757b4b8680227095b9cca8c41a3e819f2e diff --git a/docs/submodules/aai/esr-server.git b/docs/submodules/aai/esr-server.git -Subproject 01f832064230eeaa2e5cd7be45ab653e8d9d5d5 +Subproject 1864177da8c2b3794204c22e0ba1a54320c4281 diff --git a/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git -Subproject 27bcf86da3ba3a68c209db411292ea090fd8df5 +Subproject 5ce42784a2d2b02715bd4fa46c52f4b1e06c4b9 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 78d9022a5ced9d4757e005723cb710b2a5c2c08 +Subproject d9c077726cbf0a83860b103da5d409a817a49a8 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 8c3c912f2fe3d13b36859a4825a338bc3715903 +Subproject 3ebdcbdb674900fd441dd67a471b80a62cbe144 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject fc5f371d7894ef39bbaff21de4254ad45837fce +Subproject b29365aaa865630d10f2f0473e34cea9db6a287 diff --git a/docs/submodules/ccsdk/apps.git b/docs/submodules/ccsdk/apps.git -Subproject 01eff6bc81499a9e41395f6b384a5e893b36650 +Subproject f37394b3ef74842247dd381ab538c5ffb544965 diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject 933e47233a168840a64e3ac97711a35d0e5731f +Subproject 57e97e6e0abe1f42c8596f9b9dbbe202ca4e091 diff --git a/docs/submodules/ccsdk/dashboard.git b/docs/submodules/ccsdk/dashboard.git -Subproject 3df51c6bb79df182be4f0f1bac20bde75f43449 +Subproject 2e98a6c64dcdc0891f3729abb045115b790a2c5 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject a41427f14b8b056640e5853f5ec61284fb23aca +Subproject 14e324265233976dabca043d91dbdb7bc729e31 diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git -Subproject e3948b0308c817f0b43918731ee26dab6202c0c +Subproject 7745b8afc3ccd1c94a4d26e70eb6b8b63b56cd1 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 322f2fe16e1649833ade316d367c30e203d2c26 +Subproject 4549fd92024cdadf3277d7cc364f33109ca22b5 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject f6c8240d32fadd879127644c54bd5c62413319c +Subproject 72e01174faa3376fb5c095715b3e4cca037ff96 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject fdd14ecf4856426b95499d8a523dbb0b640e976 +Subproject 3a715095c50917f955ea2ea495febe08481e2c1 diff --git a/docs/submodules/dmaap/buscontroller.git b/docs/submodules/dmaap/buscontroller.git -Subproject 7f7da1e1af9b4a273ce166984ba0113d6355f44 +Subproject aa3cc0e7cd53265e8c82b56caf2f409ed5612e8 diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git -Subproject c112367f5a49647d3ae962dd77d61d82193a4b3 +Subproject 4f1d5968c50f43d7443d4ad7fcfb49d019fd5cd diff --git a/docs/submodules/dmaap/dbcapi.git b/docs/submodules/dmaap/dbcapi.git -Subproject d6ac6f8b10e90411dd650d6f7a9ee51179e39bf +Subproject bfe1f5204aa40a4178c005f23e530401b991ac5 diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git -Subproject ea0c457917a9c6a2f53c0896a69ca132aa6ca9e +Subproject 6df9f124121aa094bc69fddbe6840b278bdfc8e diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject 750ae4a611050eb0e33f4f5420aa0297b59790e +Subproject 6315cbdccedc3354cf8c1e36c4ab7aa207cd33a diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject c5765c3e4a9240403c47a57993adae0a7c6dece +Subproject 0a4965cdd243da130f98b102a4f011c559a4d5e diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 9d013afce190ff5b94473da93b4a58fe8372960 +Subproject 3c57f672700f8550370cc7a3f1b431e77590748 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject 45b3bab6fffd459396b85562f630c5aa29b6292 +Subproject f348bb53df69eb9a9f868604d0bbbb3c5e98e77 diff --git a/docs/submodules/logging-analytics/pomba/pomba-audit-common.git b/docs/submodules/logging-analytics/pomba/pomba-audit-common.git -Subproject 411e3e86f40b590f130f3379af0ca3df047c99c +Subproject a02155579db86eecd915db954aa65424273958c diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 64a42e8266437be21281f5aa08a1592f7667b5f +Subproject 03991d6387401327cf17b3389521262ec2c89de diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 71816fa7c8eeeab52db7945ec3b319817d6a7eb +Subproject 658602b4808bd093b75adb6a151982a7b44c7f0 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 57b4c6fe822a1e36a37a0656af191631f539719 +Subproject 771d3a4cc273f8ddea2a4bb4de09b9ef7c85505 diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject d8763f3be65a55a10618385dd2aeea525a87707 +Subproject f379cb8c8a5d8cf4290fd6e105f66e4fd4cdabe diff --git a/docs/submodules/music.git b/docs/submodules/music.git -Subproject 4d6e2a982cc0ee48aca9d8531424d795e44842c +Subproject 0db1ea358fdc74daf7b2039f7364ca0fff08bc7 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject da5bf006efb61f62772c48feb6dc906c7c8ba43 +Subproject e815adac21fa8a4514e5787ff2d9ef5f54cee69 diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject f3491548c657ac1c7f7840eb664e923d5d63c75 +Subproject e9fca5ef39ebdc51d4d0f1af175960fb51cd903 diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject de4d01c9cad1a228946f098a82c3039b572da1f +Subproject 4720b950ac24eb1a9b93dba9d9bd0b7dc23f243 diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git -Subproject efd0a257cf6a81a62ec18962eae1d5c1cf87bcd +Subproject a9c0c4b8343414621f298098cf5746bf2a910a9 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject dab3085222371ba0794a5ab31cee2dcde905416 +Subproject 6be302e455460b62865bae6ab23e7e3dc683193 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 90c460aa3c23c9a12885894b4664f7c742c8d29 +Subproject d83268a4cb465fa79f8b57483517226d588fb42 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject e4ecd51f615f81fca7567aac583892a32f6a4c3 +Subproject ff8c5e9f78b46f29c08576393438e902ea6d8cd diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 51a6d1ee5fdf64c87215f3381e29eb0a70d08fd +Subproject 5dcab58e8828ae4ea5dcde79103dd74db86fe42 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject 8ebd71ed51786d84d9b3cadae421db409a71903 +Subproject 1d08ac7a18f134c9d707d2c280f9531829ef1bf |