diff options
| -rw-r--r-- | conf.py | 170 | ||||
| -rw-r--r-- | docs/Chapter8/index.rst | 1 | ||||
| -rw-r--r-- | docs/Chapter9/index.rst | 11 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | etc/requirements.txt | 10 |
5 files changed, 160 insertions, 33 deletions
@@ -1,20 +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 @@ -32,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 @@ -41,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 @@ -51,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'] @@ -70,18 +66,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'2017 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. @@ -98,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. @@ -132,6 +131,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 @@ -140,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". @@ -170,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. @@ -196,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 +376,115 @@ 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 -%} +""" diff --git a/docs/Chapter8/index.rst b/docs/Chapter8/index.rst index 503dc8c..dfe2255 100644 --- a/docs/Chapter8/index.rst +++ b/docs/Chapter8/index.rst @@ -13,5 +13,4 @@ Appendix Ansible-JSON-Key-Value-Description VNF-License-Information-Guidelines TOSCA-model - Requirement-List Ansible-Playbook-Examples diff --git a/docs/Chapter9/index.rst b/docs/Chapter9/index.rst new file mode 100644 index 0000000..fd985a0 --- /dev/null +++ b/docs/Chapter9/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Requirement List +=================== + +.. needtable:: + :style: datatables + :columns: id;content;target;keyword;sections
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 297a762..ef0d8f5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,3 +18,4 @@ VNF Requirements Documentation Chapter6/index Chapter7/index Chapter8/index + Chapter9/index
\ No newline at end of file diff --git a/etc/requirements.txt b/etc/requirements.txt index d27b394..db5c4ac 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -15,16 +15,20 @@ ############################################################################# tox -Sphinx==1.6.7 +Sphinx==1.7 doc8 docutils +docopt==0.6.2 setuptools six sphinx_rtd_theme sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 +sphinxcontrib-httpdomain +sphinxcontrib-needs>=0.2.4 +sphinx_bootstrap_theme>=0.4.11 sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-swaggerdoc sphinxcontrib-plantuml -sphinx_bootstrap_theme>=0.4.11
\ No newline at end of file +xlwt==1.3.0 +PyYAML>=3.10,<4 |