Updated git submodules

[doc.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 2ecd6d5..83d9c9d 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,6 +15,7 @@
 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
@@ -24,7 +25,7 @@ import shlex
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.6.3'
+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
@@ -36,9 +37,19 @@ extensions = [
     'sphinx.ext.todo',
     'sphinx.ext.imgmath',
     'sphinx.ext.viewcode',
-    'sphinxcontrib.blockdiag'
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.nwdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.todo',
+    'sphinxcontrib.plantuml',
+    'sphinxcontrib.swaggerdoc'
 ]
 
+# Font path for seqdiag
+seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
+nwdiag_fontpath =  '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -54,18 +65,19 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'ONAP'
-copyright = u'2017, ONAP Contributors'
-author = u'ONAP Contributors'
+project = u''
+copyright = u'2018 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
+
+
+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 = 'pre-release alpha'
+version = '2.0.0'
 # The full version, including alpha/beta/rc tags.
-release = 'Amsterdam 0.1 alpha'
+release = 'Beijing'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -83,8 +95,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = [
-       '_build',
-       'templates'
+       '_build' 
        ]
 
 # The reST default role (used for this markup: `text`) to use for all
@@ -119,6 +130,7 @@ todo_include_todos = True
 
 # 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
@@ -127,7 +139,7 @@ html_theme = 'classic'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+#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".
@@ -157,7 +169,7 @@ html_static_path = ['_static']
 
 # 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'
+html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -183,7 +195,7 @@ html_static_path = ['_static']
 #html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 #html_show_copyright = True
@@ -363,3 +375,54 @@ epub_exclude_files = ['search.html']
 
 # If false, no index is generated.
 #epub_use_index = True
+
+# Patterns to ignore in linkcheck builder
+linkcheck_ignore = [
+       r'http://$',
+       r'http:/$',
+       r'http://10\.',
+       r'http://127\.',
+       r'http://172\.[123]',
+       r'http://app_host:port/',
+       r'http://app-host:port/',
+       r'http://ESR_SERVICE_IP',
+       r'http://ESR_SERVER_IP',
+       r'http://hostIP:\d+/',
+       r'http://load-balanced-address:\d+/',
+       r'http://localhost',
+       r'http://\$msb_address/',
+       r'http://\$MSB_SERVER_IP:\d+/',
+       r'http://msb_docker_host_ip:\d+/',
+       r'http://MSB_IP:MSB_PORT/',
+       r'http://msb.onap.org',
+       r'http://MSB_SERVER_IP:\d+/',
+       r'http://org.openecomp.',
+       r'http://{PDP_URL}:\d+/',
+       r'http://servername.domain.com',
+       r'http://.*simpledemo.openecomp.org',
+       r'http://.*simpledemo.onap.org',
+       r'http://.*test.att.com:\d+/',
+       r'http://we-are-data-router.us',
+       r'http://we-are-message-router.us:\d+/'
+       r'http://www.\[host\]:\[port\]/',
+       r'http://yourhostname',
+       r'https://$',
+       r'https:/$',
+       r'https://10\.',
+       r'https://127\.',
+       r'https://172\.[123]',
+       r'https://aaf.onap.org',
+       r'https://\$CBAM_IP',
+       r'https://ESR_SERVICE_IP',
+       r'https://ESR_SERVER_IP',
+       r'https://msb.onap.org',
+       r'https://my-subscriber-app.dcae',
+       r'https://\$CBAM_IP:\d+/',
+       r'https://load-balanced-address:\d+/',
+       r'https://prov.datarouternew.com:8443',
+       r'https://.*simpledemo.openecomp.org',
+       r'https://.*simpledemo.onap.org',
+       r'https://.*test.att.com:\d+/',
+       r'https://we-are-data-router.us',
+       r'https://we-are-message-router.us:\d+/'
+       ]