'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag',
+ 'sphinxcontrib.needs',
'sphinxcontrib.nwdiag',
'sphinxcontrib.seqdiag',
'sphinx.ext.ifconfig',
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 -%}
+"""
../../../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
----------------------------
- 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
+
========================
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
-Subproject commit b7440251f26be4e879ae607c3981a3799b8b3909
+Subproject commit 32cdd553a8668e6d03a9cf5b11b360d35a63c87f
-Subproject commit 8eb91b97baac63b085a8d75407b85841ff9f4444
+Subproject commit 15f771a0cdada988f44b604b9baa30c8b374cab2
-Subproject commit 75370173d19e97967d34b3c117f1e3c0820c2553
+Subproject commit dd29b7fa91d835a29b62e078a53bc82a6d0c4c10
-Subproject commit 767c14f4326941170683bbc3ed6a69fe3725b459
+Subproject commit f3872f1f9c21a83eebfbed4c4910e28b9f02d24a
-Subproject commit 801522fa8e8c14a92bc7078b7afa8ebc3c4be36b
+Subproject commit 7f8d027ddd80f41004ac93b47caa7f7c8721601a
-Subproject commit 95c897c3c85c305f676dc04adc2f167fecfc598b
+Subproject commit 5482cee27404b6d545a3f1e9714d0076e811b4bd
-Subproject commit 41a0983d5dd3707b5fd2c86dcc0b4b0c399bd40f
+Subproject commit f42670da77dabfb638c6b180ac7133ec869ecc69
-Subproject commit 80941b3f869da79f3c3f2a79be77aab0180c574e
+Subproject commit 13591a022d59d11d1301c459ab66b8e2abb8ac47
-Subproject commit cc3142b7f07c697167ace366887acb2836bb48ef
+Subproject commit 536c49b27d07ada858e152fefd036b6d6060ecb4
-Subproject commit 056e82aa242f7df59c72dc967f38d479c51f7509
+Subproject commit ea56542af7139307acd2c9a6476e04ac40c278be
-Subproject commit 8cc38860e74391e8efd732ced4a8e14fc8dc8218
+Subproject commit 13293d90149b41ad29f76f1303c23c124109b1e9
-Subproject commit cec8e7c0f90be290796d9a666edeea97e118a26f
+Subproject commit c5552def064cc4643ac879ec5f116c27f4cd088e
-Subproject commit 21ebe86d82cb7e7700e45df9873ef5ca1834fc76
+Subproject commit b0ff445fb7b53db882997ec0fd0e843b5c92a413
-Subproject commit eaac78d809a0a019718cb8b070f496b6883bb130
+Subproject commit 9d02e4106fd08585d12999faf72867fafe6ce007
-Subproject commit 955500a4aa5c86a1ccc8c4bdf81c65daff41070a
+Subproject commit f595e173fdb3921cb6c6855f5389871ee3c3ada3
-Subproject commit a42cd685193bd9156a25fe0708ba8c4a30664137
+Subproject commit 9dc24ae6efc0d070ae446b87c6268bb3cd353034
-Subproject commit 8490a957d5200419a0b8e60c35d8b2c7ecb1ba6e
+Subproject commit d70f48853bf9ab690f3019b1682c422a6854fd8b
-Subproject commit 56c8610f708a4f6a20cb86428a88d917289fb651
+Subproject commit 0b1df79ef7749d62b4412e5433538d32feb6850c
-Subproject commit b1d31973db0cf699ef65d862c2fcf02177aafac5
+Subproject commit 2ad7580242d28496a875dbceeacad546e58c7201
-Subproject commit f78f68dc817cbbf76f2d65e68c955f0ec3e65d2d
+Subproject commit af1410de64d463905dd6deee62efdd88ff616ce8
-Subproject commit 21253185c17ef038e71146112fc948b7c9ad572f
+Subproject commit d4abfa7ac6ec1a3495dfd655379acf8e9262885c
-Subproject commit f58274713412c8932e69ff41eb01244e65bffd31
+Subproject commit 87e46652b3f319d0b63df22e6782775d5c6ce3d8
-Subproject commit 5e5d6ed9badebfbc1cc65a90e3de8dad232f9e42
+Subproject commit 9b6efbd93a12c858a0d2643013217ec3d6c3a46d
-Subproject commit 060359c287c7a328804a9a6012cbbede3219562b
+Subproject commit 154a540188bb212a5e431e91e02044c661ae3c02
-Subproject commit a783f589b9cc06e10f6eed93ede754353eb6e720
+Subproject commit 1d048cfce20317c3beb85519c198e8d114b1c819
-Subproject commit 9fe615529a9fb71d347a5ef6fd88768a45bfa680
+Subproject commit 2fc33e4237e0dc0a383efc4ff04a2ba334799744
-Subproject commit 1577c271f66912e13770eb3950a25ae40cf9c4ad
+Subproject commit 9bfa1d61dc77973f85a42174b199d4c744265521
-Subproject commit 4072269d9f6b452aaff41fc02b09bfca40356dd5
+Subproject commit fe3a67c11b65d7989a6ef648c3f34eee8abe7394
-Subproject commit 1a7d92fbe4118e74a6a57872c920ad83ee05650d
+Subproject commit d0eaecacec822c0332a31f499f9d972c9b39e691
-Subproject commit 718f5b1ab6d4338b6128671d558034eddfd139d8
+Subproject commit 842633530e7c1615f988cf58fcc9b472fe5b5fe1
-Subproject commit c3faa49849665b4e84c058e9ac1bf12c280299ba
+Subproject commit 470b614cd002e78155944b653ac1e2f974521079
-Subproject commit 16c48c29687bef763299321057767ff1fdcb0d4d
+Subproject commit 7b29a376f0b211dccc35cb1d7f73e011bcad016b
-Subproject commit 110b9d3f108e8f81f705ec4eeb2102f98f220d39
+Subproject commit 86a008a5b0f0f22356f64b86d9c4c51f9cf09cdc
-Subproject commit 1336ef0ccd540266b63924d9aad4d375dc74b79b
+Subproject commit 3a7c2f77e9d045e31139aee67dffe25a7add49f2
-Subproject commit ea20ae71a0c2bd88d155afaed03ef7aed3e6b5c1
+Subproject commit 7d894a773aedd079e7b65414299334982a38532d
-Subproject commit fa5ce71293ba07ee8f0978fa81ab97c6bf26dfc2
+Subproject commit ce4a4fa0bef0fbede2e6d55460091ebe5cdf0f67
-Subproject commit 39a5994da3b9b6c900e16c5c4b015e1aea780adc
+Subproject commit ff76b5ed0aa91d5fdf9dc4f95e8b20f91ed9d072
-Subproject commit e5d69d664eb5a0af499ca2941f2e415778c945af
+Subproject commit 75fc8abdfa55e7aef77a006e03853f2180901850
-Subproject commit fe3390395d97f1a0fe2e8f4ab5cd8a3d08070958
+Subproject commit 2fc6ebc537028f72788cf7b169970e1aa3ddfbb0
-Subproject commit cdc4c8d541d2962868cd146084c79bd02482a6d2
+Subproject commit 3ade6cdb4282277c68dd599f0f03aab8d1bd4615
-Subproject commit 092c7be21635f9423f2b4383164f3286a76f8964
+Subproject commit dd8908a9fd4182ba87dad31f3bfe09dbaed5b92e
-Subproject commit c85a341c7a00c910a737d50d3f11cd8f923c6641
+Subproject commit 6dee9df5bf854047df8b1c0944dad13f77d0c9ee
six
sphinx_rtd_theme
sphinxcontrib-blockdiag
+sphinxcontrib-needs>=0.2.3
sphinxcontrib-nwdiag
sphinxcontrib-seqdiag
sphinxcontrib-swaggerdoc