blob: 7b5e2b7d02354d3be65bab75dfb143aa84658670 [file] [log] [blame]
Aric Gardner0fb94b12020-01-28 15:21:34 -05001from docs_conf.conf import *
Rich Bennett22ef0852017-07-19 18:05:55 -04002
Aric Gardnera78f0db2020-06-26 13:09:32 -04003doc_url = 'https://docs.onap.org/projects'
Rich Bennett22ef0852017-07-19 18:05:55 -04004master_doc = 'index'
5
Aric Gardner0fb94b12020-01-28 15:21:34 -05006intersphinx_mapping = {}
Rich Bennettc5995662017-10-18 15:27:52 -04007
Andreas Geisslerfc99e1b2021-10-19 11:10:28 +00008#
thmsdt1cc31c32022-03-16 13:55:01 +01009# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
10# Change to {releasename} after you have created the new 'doc' branch.
Andreas Geisslerfc99e1b2021-10-19 11:10:28 +000011#
12
thmsdt1cc31c32022-03-16 13:55:01 +010013# latest|{releasename}
thmsdte2f3acb2021-11-15 14:39:44 +010014branch = 'latest'
andreasgeissleref2ee3f2021-03-18 16:00:37 +010015intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010016intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
thmsdt9d2461c2021-11-12 10:35:10 +010017intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010018intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020019intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010020intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010021intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
thmsdt67ce52a2022-06-27 13:07:45 +020022intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010023intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
Eric Debeau84037692021-10-06 19:54:57 +020024intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010025intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010026intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020027intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
28intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010029intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
thmsdt1190a2f2022-03-15 15:21:49 +010030intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
31intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
andreasgeissleref2ee3f2021-03-18 16:00:37 +010032intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020033intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
thmsdt67ce52a2022-06-27 13:07:45 +020034intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010035intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
36intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
37intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
38intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020039intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
thmsdt9d2461c2021-11-12 10:35:10 +010040intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020041intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
andreasgeisslercb391d02021-04-01 17:27:20 +020042intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
thmsdt67ce52a2022-06-27 13:07:45 +020043intersphinx_mapping['onap-oom-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020044intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010045intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
andreasgeisslercb391d02021-04-01 17:27:20 +020046intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
andreasgeissler3a170f72021-04-01 10:17:03 +020047intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
48intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
49intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
50intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
51intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
thmsdt67ce52a2022-06-27 13:07:45 +020052intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
thmsdt1801ddf2022-03-15 17:40:26 +010053
thmsdt6458ba72022-06-27 16:45:45 +020054# One exception for osa repo for Jakarta release only! For the Kohn release they are asked to create a branch!
55branch = 'latest'
56intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
57
thmsdt1cc31c32022-03-16 13:55:01 +010058# Linkcheck
Guillaume Lambert5b9d80a2021-02-02 15:07:08 +010059linkcheck_ignore = [
Andrea Visnyei32d2daf2020-12-09 12:26:35 +010060 'http://localhost',
61 'https://example.com',
Guillaume Lambert3931bb12021-02-17 11:48:28 +010062 'about:config',
63 # this URL is not directly reachable and must be configured in the system hosts file.
64 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
65 # anchor issues
66 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
67 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
68 'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
69 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
70 'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
71 'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
Guillaume Lambert5b9d80a2021-02-02 15:07:08 +010072]
Aric Gardner8a8832a2020-04-02 17:17:49 -040073
Rich Bennett80455a52017-11-08 05:17:00 -050074html_last_updated_fmt = '%d-%b-%y %H:%M'
Rich Bennett22ef0852017-07-19 18:05:55 -040075
Rich Bennett317d81a2018-09-11 07:38:05 -040076def setup(app):
Guillaume Lambert3e25eeb2021-02-02 15:35:50 +010077 app.add_css_file("css/ribbon.css")