From 87c482480137dbaf99e75b90f1f7899508e6a80a Mon Sep 17 00:00:00 2001 From: "Bozawglanian, Hagop (hb755d)" Date: Wed, 3 Oct 2018 20:15:47 +0000 Subject: VNFRQTS - Updating Test Case text Issue-ID: VNFRQTS-450 Change-Id: I368ddede947bf480fe76bf17ef7bd5916890d243 Signed-off-by: Bozawglanian, Hagop (hb755d) --- conf.py | 15 ++++++---- docs/Chapter1.rst | 10 +++++++ docs/Chapter2.rst | 29 ++++++++++++++++-- docs/_static/css/ribbon.css | 63 ++++++++++++++++++++++++++++++++++++++++ docs/_static/favicon.ico | Bin 0 -> 2102 bytes docs/_static/logo_onap_2017.png | Bin 0 -> 6980 bytes docs/_templates/layout.html | 19 ++++++++++++ etc/requirements.txt | 10 ++----- 8 files changed, 130 insertions(+), 16 deletions(-) create mode 100644 docs/_static/css/ribbon.css create mode 100755 docs/_static/favicon.ico create mode 100755 docs/_static/logo_onap_2017.png create mode 100644 docs/_templates/layout.html diff --git a/conf.py b/conf.py index 1ac1cad..fc96b8b 100644 --- a/conf.py +++ b/conf.py @@ -67,7 +67,7 @@ master_doc = 'index' # General information about the project. project = u'' -copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License' +copyright = u'2018 ONAP. Licensed under Creative Commons Attribution 4.0 International License' author = u'Open Network Automation Platform' @@ -76,9 +76,9 @@ author = u'Open Network Automation Platform' # |version| and |release|, also used in various other places throughout the # built documents. # The short X.Y version. -version = 'casablanca' +version = 'master branch' # The full version, including alpha/beta/rc tags. -release = 'latest' +release = 'master branch' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -131,8 +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 = 'bootstrap' -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 @@ -447,7 +447,7 @@ needs_extra_options = { needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" needs_id_required = True needs_title_optional = True -needs_file = "docs/data/needs.json" + needs_template_collapse = """ .. _{{id}}: @@ -488,3 +488,6 @@ needs_template_collapse = """ | parents: :need_outgoing:`{{id}}` {% endif -%} """ + +def setup(app): + app.add_stylesheet("css/ribbon.css") diff --git a/docs/Chapter1.rst b/docs/Chapter1.rst index 1c3481d..ea9dbaf 100644 --- a/docs/Chapter1.rst +++ b/docs/Chapter1.rst @@ -16,6 +16,16 @@ **VNF Package Test Cases** ========================== +The information in this section deals with the Test Cases corresponding to +the the VNF Requirements. There are two types: + + 1. VNF Package Information Element Present: which is the base case of a + Test Case, please refer to :ref:`Annex.` + + 2. VNF Package Information Element within Range Limits: refers to a Test Case + when there are Range Limits placed, please refer to + :ref:`Annex.` + VNF Package Information Element Present --------------------------------------- diff --git a/docs/Chapter2.rst b/docs/Chapter2.rst index 99c0053..eea9c0f 100644 --- a/docs/Chapter2.rst +++ b/docs/Chapter2.rst @@ -16,12 +16,22 @@ **Appendix** ============ -Appendix 1 List of VNF Requirements and corresponding Information Elements +.. _info-elements: + +List of VNF Requirements and corresponding Information Elements -------------------------------------------------------------------------- You can download the table :download:`here` +Included here is a table of VNF Requirements that are mainly referring to +the testability of VNF Package requirements. It includes TOSCA or CSAR +artifact information as well as how it is testable (VNFSDK/VVP/SDC). +These requirements are mainly from :doc:`Chapter 5 <../../../../vnfrqts/requirements.git/docs/Chapter5/index>` +and the table has been generated manually to show users what specific +artifact is being tested by a specific requirement to make mapping possible +and to show coverage. + .. csv-table:: **Test Descriptions** :file: ReqTable.csv :header-rows: 1 @@ -35,15 +45,28 @@ List of Requirements with associated Tests You can download the table :download:`here` +This table shows all the requirements within the VNF Requirements project with +the section they are in, associated test names and modules. This is generated +dynamically within the VVP project, where it pulls down the latest JSON from +:doc:`Chapter 9 - Requirement List <../../../../vnfrqts/requirements.git/docs/Chapter9/index>` +and maps the requirements to the tests in VVP to output this table. + + **Note: Tests on the bottom do not map to any requirements.** + + **Note: VVP only validates Heat for Requirements in Chapter 5.** + .. csv-table:: **Test Traceability** :file: traceability.csv :header-rows: 1 :align: center :widths: auto -Appendix 2 List of VNF Requirements and corresponding Information Elements with Range limits ---------------------------------------------------------------------------------------------- +.. _info-elements-range-limits: + +VNF Requirements corresponding Information Elements w/Range limits +------------------------------------------------------------------------------ +Will be generated in future releases. .. [#4.1.1] Refer to NCSP’s Network Cloud specification diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css new file mode 100644 index 0000000..6008cb1 --- /dev/null +++ b/docs/_static/css/ribbon.css @@ -0,0 +1,63 @@ +.ribbon { + z-index: 1000; + background-color: #a00; + overflow: hidden; + white-space: nowrap; + position: fixed; + top: 25px; + right: -50px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -ms-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + -webkit-box-shadow: 0 0 10px #888; + -moz-box-shadow: 0 0 10px #888; + box-shadow: 0 0 10px #888; + +} + +.ribbon a { + border: 1px solid #faa; + color: #fff; + display: block; + font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; + margin: 1px 0; + padding: 10px 50px; + text-align: center; + text-decoration: none; + text-shadow: 0 0 5px #444; + transition: 0.5s; +} + +.ribbon a:hover { + background: #c11; + color: #fff; +} + + +/* override table width restrictions */ +@media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; + } + + .wy-table-responsive { + overflow: visible !important; + } +} + +@media screen and (max-width: 767px) { + .wy-table-responsive table td { + white-space: nowrap; + } +} + +/* fix width of the screen */ + +.wy-nav-content { + max-width: none; +} diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100755 index 0000000..cb712eb Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png new file mode 100755 index 0000000..9f63444 Binary files /dev/null and b/docs/_static/logo_onap_2017.png differ diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..ba05e82 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,19 @@ +{# Import the theme's layout. #} +{% extends "!layout.html" %} + +{# Custom CSS override for warning banner #} +{% set css_files = css_files + ['_static/css/warning-header.css'] %} + +{# Ribbon #} +{% block content %} +
+ + Report Issue + +
+ {{ super() }} +{% endblock %} diff --git a/etc/requirements.txt b/etc/requirements.txt index db5c4ac..29b5d98 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -15,20 +15,16 @@ ############################################################################# tox -Sphinx==1.7 +Sphinx==1.6.7 doc8 docutils -docopt==0.6.2 setuptools six sphinx_rtd_theme sphinxcontrib-blockdiag -sphinxcontrib-httpdomain -sphinxcontrib-needs>=0.2.4 -sphinx_bootstrap_theme>=0.4.11 +sphinxcontrib-needs>=0.2.3 sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-swaggerdoc sphinxcontrib-plantuml -xlwt==1.3.0 -PyYAML>=3.10,<4 +sphinx_bootstrap_theme>=0.4.11 -- cgit 1.2.3-korg