summaryrefslogtreecommitdiffstats
path: root/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'conf.py')
-rw-r--r--conf.py173
1 files changed, 144 insertions, 29 deletions
diff --git a/conf.py b/conf.py
index 243aaaa..b5f690d 100644
--- a/conf.py
+++ b/conf.py
@@ -1,19 +1,3 @@
-##############################################################################
-# Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
-# ===================================================================
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#############################################################################
-
# -*- coding: utf-8 -*-
#
# ONAP documentation build configuration file, created by
@@ -31,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
@@ -40,7 +25,7 @@ import shlex
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+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
@@ -50,10 +35,22 @@ extensions = [
'sphinx.ext.doctest',
'sphinx.ext.graphviz',
'sphinx.ext.todo',
- 'sphinx.ext.pngmath',
+ 'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
+ 'sphinxcontrib.blockdiag',
+ 'sphinxcontrib.needs',
+ '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']
@@ -69,18 +66,19 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'ONAP'
-copyright = u'2018, 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 = 'test'
+version = 'master branch'
# The full version, including alpha/beta/rc tags.
-release = 'test'
+release = 'master branch'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -97,7 +95,9 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = [
+ '_build'
+ ]
# The reST default role (used for this markup: `text`) to use for all
# documents.
@@ -131,7 +131,8 @@ 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 = 'classic'
+#html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
# 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
@@ -139,7 +140,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".
@@ -169,7 +170,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.
@@ -195,7 +196,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
@@ -376,3 +377,117 @@ 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+/'
+ ]
+
+from docutils.parsers.rst import directives
+
+needs_extra_options = {
+ "target": directives.unchanged,
+ "keyword": directives.unchanged,
+ "introduced": directives.unchanged,
+ "updated": directives.unchanged,
+ "impacts": directives.unchanged,
+ "validation_mode": directives.unchanged,
+ "validated_by": directives.unchanged,
+ "test": directives.unchanged,
+ "test_case": directives.unchanged,
+ "test_file": directives.unchanged,
+ "notes": directives.unchanged,
+}
+
+needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+"
+needs_id_required = True
+needs_title_optional = True
+
+needs_template_collapse = """
+.. _{{id}}:
+
+{% if hide == false -%}
+.. role:: needs_tag
+.. role:: needs_status
+.. role:: needs_type
+.. role:: needs_id
+.. role:: needs_title
+
+.. rst-class:: need
+.. rst-class:: need_{{type_name}}
+
+.. container:: need
+
+ `{{id}}` - {{content|indent(4)}}
+
+ .. container:: toggle
+
+ .. container:: header
+
+ Details
+
+{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %}
+{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %}
+{% if keyword %} | keyword: `{{keyword}}` {% endif %}
+{% if target %} | target: `{{target}}` {% endif %}
+{% if introduced %} | introduced: `{{introduced}}` {% endif %}
+{% if updated %} | updated: `{{updated}}` {% endif %}
+{% if impacts %} | impacts: `{{impacts}}` {% endif %}
+{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %}
+{% if validated_by %} | validated by: `{{validated_by}}` {% endif %}
+{% if test %} | test: `{{test}}` {% endif %}
+{% if test_case %} | test case: {{test_case}} {% endif %}
+{% if test_file %} | test file: `{{test_file}}` {% endif %}
+{% if notes %} | notes: `{{notes}}` {% endif %}
+ | children: :need_incoming:`{{id}}`
+ | parents: :need_outgoing:`{{id}}`
+{% endif -%}
+"""
+
+def setup(app):
+ app.add_stylesheet("css/ribbon.css")