blob: 296ef99b03ecaed8259158a091ed210a69618987 [file] [log] [blame]
Aric Gardner0fb94b12020-01-28 15:21:34 -05001from docs_conf.conf import *
Rich Bennett22ef0852017-07-19 18:05:55 -04002
Eric Debeaudfd985f2020-11-26 16:01:59 +01003branch = 'latest'
Aric Gardnera78f0db2020-06-26 13:09:32 -04004doc_url = 'https://docs.onap.org/projects'
Rich Bennett22ef0852017-07-19 18:05:55 -04005master_doc = 'index'
6
Aric Gardner0fb94b12020-01-28 15:21:34 -05007linkcheck_ignore = [
8 'http://localhost',
9]
Rich Bennettc5995662017-10-18 15:27:52 -040010
Aric Gardner0fb94b12020-01-28 15:21:34 -050011intersphinx_mapping = {}
Rich Bennettc5995662017-10-18 15:27:52 -040012
Aric Gardner8a8832a2020-04-02 17:17:49 -040013intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
14intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
Aric Gardnerb9606a32020-04-06 14:48:39 -040015intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
Aric Gardner8a8832a2020-04-02 17:17:49 -040016intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
17intersphinx_mapping['onap-music-distributed-kv-store'] = ('{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
18intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
19intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
20intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
21intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
22intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
23intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
24intersphinx_mapping['onap-modeling-toscaparsers'] = ('{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
25intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
26intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None)
27intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
28intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
29intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
30intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
31intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
32intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
33intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None)
34intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ('{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
35intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
36intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None)
37intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ('{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
38intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
39intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
40intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
41intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
42intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
43intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
44intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
45intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
Aric Gardner8a8832a2020-04-02 17:17:49 -040046intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
47intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
Eric Debeauba9b7272020-11-25 13:37:11 +010048intersphinx_mapping['onap-oom-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
Aric Gardner8a8832a2020-04-02 17:17:49 -040049intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
50intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
elinuxhenrikb9438032020-09-21 15:40:03 +020051intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
Aric Gardner8a8832a2020-04-02 17:17:49 -040052intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
53intersphinx_mapping['onap-ccsdk-platform-plugins'] = ('{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
54intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
55intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
56intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
57intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
58intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
59intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
60intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
61intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
62intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
63intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
64intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None)
65intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
66intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
67intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ('{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
68intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
69intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
70intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None)
71intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None)
72intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
73intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None)
74intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None)
75intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
76intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
77intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
78intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
79intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
80intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
81intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
82
83
Guillaume Lambert5b9d80a2021-02-02 15:07:08 +010084linkcheck_ignore = [
85 'about:config',
86 # this URL is not directly reachable and must be configured in the system hosts file.
87 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
88 # anchor issues
89 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
90 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
91 'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
92 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
93 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
94 'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
95]
Aric Gardner8a8832a2020-04-02 17:17:49 -040096
97
98
Rich Bennett80455a52017-11-08 05:17:00 -050099html_last_updated_fmt = '%d-%b-%y %H:%M'
Rich Bennett22ef0852017-07-19 18:05:55 -0400100
Rich Bennett317d81a2018-09-11 07:38:05 -0400101def setup(app):
Guillaume Lambert3e25eeb2021-02-02 15:35:50 +0100102 app.add_css_file("css/ribbon.css")
Aric Gardnere2417212020-02-07 13:56:45 -0500103
104
105from docutils.parsers.rst import directives
106
107needs_extra_options = {
108 "target": directives.unchanged,
109 "keyword": directives.unchanged,
110 "introduced": directives.unchanged,
111 "updated": directives.unchanged,
112 "impacts": directives.unchanged,
113 "validation_mode": directives.unchanged,
114 "validated_by": directives.unchanged,
115 "test": directives.unchanged,
116 "test_case": directives.unchanged,
117 "test_file": directives.unchanged,
118 "notes": directives.unchanged,
119}
120
121needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+"
122needs_id_required = True
123needs_title_optional = True
124
125needs_template_collapse = """
126.. _{{id}}:
127
128{% if hide == false -%}
129.. role:: needs_tag
130.. role:: needs_status
131.. role:: needs_type
132.. role:: needs_id
133.. role:: needs_title
134
135.. rst-class:: need
136.. rst-class:: need_{{type_name}}
137
138.. container:: need
139
140 `{{id}}` - {{content|indent(4)}}
141
142 .. container:: toggle
143
144 .. container:: header
145
146 Details
147
148{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %}
149{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %}
150{% if keyword %} | keyword: `{{keyword}}` {% endif %}
151{% if target %} | target: `{{target}}` {% endif %}
152{% if introduced %} | introduced: `{{introduced}}` {% endif %}
153{% if updated %} | updated: `{{updated}}` {% endif %}
154{% if impacts %} | impacts: `{{impacts}}` {% endif %}
155{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %}
156{% if validated_by %} | validated by: `{{validated_by}}` {% endif %}
157{% if test %} | test: `{{test}}` {% endif %}
158{% if test_case %} | test case: {{test_case}} {% endif %}
159{% if test_file %} | test file: `{{test_file}}` {% endif %}
160{% if notes %} | notes: `{{notes}}` {% endif %}
161 | children: :need_incoming:`{{id}}`
162 | parents: :need_outgoing:`{{id}}`
163{% endif -%}
164"""
165