diff options
47 files changed, 99 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 815d0d0a3..f81a78b43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinxcontrib.blockdiag', + 'sphinxcontrib.needs', 'sphinxcontrib.nwdiag', 'sphinxcontrib.seqdiag', 'sphinx.ext.ifconfig', @@ -426,3 +427,64 @@ linkcheck_ignore = [ 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/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 331248c2f..3524cf652 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -190,6 +190,17 @@ ONAP Operations Manager (experimental) ../../../submodules/oom.git/docs/index +ONAP Optimization Framework +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/optf/has.git/docs/index + ../../../submodules/optf/osdf.git/docs/index + + ONAP Use Case User Interface ---------------------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst index 74fc261c1..324688551 100644 --- a/docs/guides/onap-developer/how-to-use-docs/style-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/style-guide.rst @@ -118,3 +118,27 @@ Tasks - Break down end-to-end tasks into manageable chunks. + +ONAP Conventions for the Use of Sphinx Directives +------------------------------------------------- + +Needs Directive +^^^^^^^^^^^^^^^ + + * Needs IDs must match the regular expression "^[A-Z0-9]+-[A-Z0-9]+" + + * The prefix (string before the dash) must be described in the following table + +.. list-table:: Needs Prefix Use + :align: center + :widths: 8 40 40 + :header-rows: 1 + + * - Prefix + - Description + - Use + + * - R + - Represents a requirement that must be met by a VNF provider + - Defined only in the vnfrqts project repositories, may be referenced in any project repository source + diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst index 833393d33..afbbd6bf8 100644 --- a/docs/guides/onap-developer/settingup/onap_heat.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -408,7 +408,7 @@ command: ======================== The current ONAP installation is using the *onap.org* domain. To use the portal on your desktop, you must configure the following information -in your *host* file (located in /etc/host for Linux or +in your *host* file (located in /etc/hosts for Linux or /windows/system32/drivers/etc/hosts for Windows): .. code-block:: bash diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject b7440251f26be4e879ae607c3981a3799b8b390 +Subproject 32cdd553a8668e6d03a9cf5b11b360d35a63c87 diff --git a/docs/submodules/aaf/sms.git b/docs/submodules/aaf/sms.git -Subproject 8eb91b97baac63b085a8d75407b85841ff9f444 +Subproject 15f771a0cdada988f44b604b9baa30c8b374cab diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject 75370173d19e97967d34b3c117f1e3c0820c255 +Subproject dd29b7fa91d835a29b62e078a53bc82a6d0c4c1 diff --git a/docs/submodules/aai/esr-gui.git b/docs/submodules/aai/esr-gui.git -Subproject 767c14f4326941170683bbc3ed6a69fe3725b45 +Subproject f3872f1f9c21a83eebfbed4c4910e28b9f02d24 diff --git a/docs/submodules/aai/esr-server.git b/docs/submodules/aai/esr-server.git -Subproject 801522fa8e8c14a92bc7078b7afa8ebc3c4be36 +Subproject 7f8d027ddd80f41004ac93b47caa7f7c8721601 diff --git a/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git -Subproject 95c897c3c85c305f676dc04adc2f167fecfc598 +Subproject 5482cee27404b6d545a3f1e9714d0076e811b4b diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 41a0983d5dd3707b5fd2c86dcc0b4b0c399bd40 +Subproject f42670da77dabfb638c6b180ac7133ec869ecc6 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 80941b3f869da79f3c3f2a79be77aab0180c574 +Subproject 13591a022d59d11d1301c459ab66b8e2abb8ac4 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject cc3142b7f07c697167ace366887acb2836bb48e +Subproject 536c49b27d07ada858e152fefd036b6d6060ecb diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 056e82aa242f7df59c72dc967f38d479c51f750 +Subproject ea56542af7139307acd2c9a6476e04ac40c278b diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git -Subproject 8cc38860e74391e8efd732ced4a8e14fc8dc821 +Subproject 13293d90149b41ad29f76f1303c23c124109b1e diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git -Subproject cec8e7c0f90be290796d9a666edeea97e118a26 +Subproject c5552def064cc4643ac879ec5f116c27f4cd088 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 21ebe86d82cb7e7700e45df9873ef5ca1834fc7 +Subproject b0ff445fb7b53db882997ec0fd0e843b5c92a41 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject eaac78d809a0a019718cb8b070f496b6883bb13 +Subproject 9d02e4106fd08585d12999faf72867fafe6ce00 diff --git a/docs/submodules/dmaap/dbcapi.git b/docs/submodules/dmaap/dbcapi.git -Subproject 955500a4aa5c86a1ccc8c4bdf81c65daff41070 +Subproject f595e173fdb3921cb6c6855f5389871ee3c3ada diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git -Subproject a42cd685193bd9156a25fe0708ba8c4a3066413 +Subproject 9dc24ae6efc0d070ae446b87c6268bb3cd35303 diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject 8490a957d5200419a0b8e60c35d8b2c7ecb1ba6 +Subproject d70f48853bf9ab690f3019b1682c422a6854fd8 diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject 56c8610f708a4f6a20cb86428a88d917289fb65 +Subproject 0b1df79ef7749d62b4412e5433538d32feb6850 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject b1d31973db0cf699ef65d862c2fcf02177aafac +Subproject 2ad7580242d28496a875dbceeacad546e58c720 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject f78f68dc817cbbf76f2d65e68c955f0ec3e65d2 +Subproject af1410de64d463905dd6deee62efdd88ff616ce diff --git a/docs/submodules/msb/apigateway.git b/docs/submodules/msb/apigateway.git -Subproject 21253185c17ef038e71146112fc948b7c9ad572 +Subproject d4abfa7ac6ec1a3495dfd655379acf8e9262885 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject f58274713412c8932e69ff41eb01244e65bffd3 +Subproject 87e46652b3f319d0b63df22e6782775d5c6ce3d diff --git a/docs/submodules/music.git b/docs/submodules/music.git -Subproject 5e5d6ed9badebfbc1cc65a90e3de8dad232f9e4 +Subproject 9b6efbd93a12c858a0d2643013217ec3d6c3a46 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject 060359c287c7a328804a9a6012cbbede3219562 +Subproject 154a540188bb212a5e431e91e02044c661ae3c0 diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git -Subproject a783f589b9cc06e10f6eed93ede754353eb6e72 +Subproject 1d048cfce20317c3beb85519c198e8d114b1c81 diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git -Subproject 9fe615529a9fb71d347a5ef6fd88768a45bfa68 +Subproject 2fc33e4237e0dc0a383efc4ff04a2ba33479974 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 1577c271f66912e13770eb3950a25ae40cf9c4a +Subproject 9bfa1d61dc77973f85a42174b199d4c74426552 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject 4072269d9f6b452aaff41fc02b09bfca40356dd +Subproject fe3a67c11b65d7989a6ef648c3f34eee8abe739 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 1a7d92fbe4118e74a6a57872c920ad83ee05650 +Subproject d0eaecacec822c0332a31f499f9d972c9b39e69 diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git -Subproject 718f5b1ab6d4338b6128671d558034eddfd139d +Subproject 842633530e7c1615f988cf58fcc9b472fe5b5fe diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git -Subproject c3faa49849665b4e84c058e9ac1bf12c280299b +Subproject 470b614cd002e78155944b653ac1e2f97452107 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git -Subproject 16c48c29687bef763299321057767ff1fdcb0d4 +Subproject 7b29a376f0b211dccc35cb1d7f73e011bcad016 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 110b9d3f108e8f81f705ec4eeb2102f98f220d3 +Subproject 86a008a5b0f0f22356f64b86d9c4c51f9cf09cd diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 1336ef0ccd540266b63924d9aad4d375dc74b79 +Subproject 3a7c2f77e9d045e31139aee67dffe25a7add49f diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git -Subproject ea20ae71a0c2bd88d155afaed03ef7aed3e6b5c +Subproject 7d894a773aedd079e7b65414299334982a38532 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject fa5ce71293ba07ee8f0978fa81ab97c6bf26dfc +Subproject ce4a4fa0bef0fbede2e6d55460091ebe5cdf0f6 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject 39a5994da3b9b6c900e16c5c4b015e1aea780ad +Subproject ff76b5ed0aa91d5fdf9dc4f95e8b20f91ed9d07 diff --git a/docs/submodules/vnfrqts/guidelines.git b/docs/submodules/vnfrqts/guidelines.git -Subproject e5d69d664eb5a0af499ca2941f2e415778c945a +Subproject 75fc8abdfa55e7aef77a006e03853f218090185 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject fe3390395d97f1a0fe2e8f4ab5cd8a3d0807095 +Subproject 2fc6ebc537028f72788cf7b169970e1aa3ddfbb diff --git a/docs/submodules/vnfrqts/testcases.git b/docs/submodules/vnfrqts/testcases.git -Subproject cdc4c8d541d2962868cd146084c79bd02482a6d +Subproject 3ade6cdb4282277c68dd599f0f03aab8d1bd461 diff --git a/docs/submodules/vnfrqts/usecases.git b/docs/submodules/vnfrqts/usecases.git -Subproject 092c7be21635f9423f2b4383164f3286a76f896 +Subproject dd8908a9fd4182ba87dad31f3bfe09dbaed5b92 diff --git a/docs/submodules/vvp/documentation.git b/docs/submodules/vvp/documentation.git -Subproject c85a341c7a00c910a737d50d3f11cd8f923c664 +Subproject 6dee9df5bf854047df8b1c0944dad13f77d0c9e diff --git a/etc/requirements.txt b/etc/requirements.txt index 4b8679121..8e2894c62 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -6,6 +6,7 @@ setuptools six sphinx_rtd_theme sphinxcontrib-blockdiag +sphinxcontrib-needs>=0.2.3 sphinxcontrib-nwdiag sphinxcontrib-seqdiag sphinxcontrib-swaggerdoc |