docs/conf.py

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