docs/conf.py

   1 from docs_conf.conf import *
   2
   3 # Change the line below from 'latest' to '<Name_of_the_new_ONAP_Release>' after
   4 # you have create the new branch for the 'doc' project.
   5 branch = 'latest'
   6 doc_url = 'https://docs.onap.org/projects'
   7 master_doc = 'index'
   8
   9 intersphinx_mapping = {}
  10
  11 #
  12 # Mapping to 'latest' if this files is used in 'latest' (master) branch.
  13 # Changed to '<Name_of_the_new_ONAP_Release>' after you have create the new
  14 # branch for the 'doc' project.
  15 #
  16
  17 # Istanbul
  18 intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
  19 intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
  20 intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
  21 intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
  22 intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
  23 intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
  24 intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
  25 intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
  26 intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
  27 intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None)
  28 intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None)
  29 intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
  30 intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = (
  31     '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
  32 intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
  33 intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
  34 intersphinx_mapping['onap-holmes-engine-management'] = (
  35     '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
  36 intersphinx_mapping['onap-holmes-rule-management'] = (
  37     '{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
  38 intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
  39 intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
  40 intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
  41 intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
  42 intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
  43 intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
  44 intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
  45 intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
  46 intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
  47 intersphinx_mapping['onap-oom-platform-cert-service'] = (
  48     '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
  49 #intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None)
  50 intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
  51 intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
  52 #intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None)
  53 intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
  54 intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
  55 intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
  56 intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
  57 intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
  58 intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
  59 intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
  60 intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None)
  61 intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
  62 intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
  63 # enable later and remove duplicated entry at 'honolulu' # intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
  64 intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None)
  65
  66 #
  67 # Mapping to an older version of documentation for those projects who are part
  68 # of the new ONAP release but have not created a branch for it.
  69 # This can happen e.g. for 'unmaintained' (but still required) projects.
  70 #
  71
  72 # Honolulu
  73 branch = 'honolulu'
  74 intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
  75 intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
  76 intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
  77 intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
  78
  79 # Guilin
  80 branch = 'guilin'
  81 intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
  82
  83 # Frankfurt
  84 branch = 'frankfurt'
  85 intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
  86 intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
  87 intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None)
  88
  89 #
  90 # Mapping to 'latest' (master) version of documentation for those projects who
  91 # are part of the new ONAP release but never have created a branch.
  92 #
  93
  94 # Latest
  95 branch = 'latest'
  96 intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
  97 intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
  98 intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None)
  99 #intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None)
 100 #intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None)
 101 intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
 102 intersphinx_mapping['onap-ccsdk-platform-plugins'] = (
 103     '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
 104 intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
 105 intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = (
 106     '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
 107 intersphinx_mapping['onap-modeling-toscaparsers'] = (
 108     '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
 109 intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
 110 intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
 111 intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
 112 intersphinx_mapping['onap-music-distributed-kv-store'] = (
 113     '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
 114 intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
 115 intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
 116 intersphinx_mapping['onap-sdc-sdc-distribution-client'] = (
 117     '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
 118 intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = (
 119     '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
 120 intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
 121 intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
 122 intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
 123 intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = (
 124     '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
 125
 126 linkcheck_ignore = [
 127     'http://localhost',
 128     'https://example.com',
 129     'about:config',
 130     # this URL is not directly reachable and must be configured in the system hosts file.
 131     'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
 132     # anchor issues
 133     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
 134     'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
 135     'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
 136     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
 137     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
 138     'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
 139 ]
 140
 141
 142 html_last_updated_fmt = '%d-%b-%y %H:%M'
 143
 144
 145 def setup(app):
 146     app.add_css_file("css/ribbon.css")
 147