diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-07-12 16:23:19 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-07-12 16:27:27 -0400 |
| commit | 0ec5a7558a6700a034552c95ccb616ddff6cbff1 (patch) | |
| tree | e13eb233a1ad25d935d998f8ff78f359cc014459 /docs/guides/onap-developer/how-to-use-docs | |
| parent | 7171dc0c47cfa9b9e1cffaf2dc3bff55d8111496 (diff) | |
Add support for sphinx NEEDS Directive
Add configuration, pip requirements, and conventiions for use
Change-Id: Ia065b7f72fc5aa16b4010b0100dc70e2f0a42b8c
Issue-ID: DOC-285
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/style-guide.rst | 24 |
1 files changed, 24 insertions, 0 deletions
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 + |