Aric Gardner | 0fb94b1 | 2020-01-28 15:21:34 -0500 | [diff] [blame] | 1 | from docs_conf.conf import * |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 2 | |
Aric Gardner | a78f0db | 2020-06-26 13:09:32 -0400 | [diff] [blame] | 3 | doc_url = 'https://docs.onap.org/projects' |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 4 | master_doc = 'index' |
| 5 | |
Aric Gardner | 0fb94b1 | 2020-01-28 15:21:34 -0500 | [diff] [blame] | 6 | intersphinx_mapping = {} |
Rich Bennett | c599566 | 2017-10-18 15:27:52 -0400 | [diff] [blame] | 7 | |
Andreas Geissler | fc99e1b | 2021-10-19 11:10:28 +0000 | [diff] [blame] | 8 | # |
thmsdt | 1cc31c3 | 2022-03-16 13:55:01 +0100 | [diff] [blame] | 9 | # 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 Geissler | fc99e1b | 2021-10-19 11:10:28 +0000 | [diff] [blame] | 11 | # |
| 12 | |
thmsdt | 1cc31c3 | 2022-03-16 13:55:01 +0100 | [diff] [blame] | 13 | # latest|{releasename} |
thmsdt | e2f3acb | 2021-11-15 14:39:44 +0100 | [diff] [blame] | 14 | branch = 'latest' |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 15 | intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 16 | intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) |
thmsdt | 9d2461c | 2021-11-12 10:35:10 +0100 | [diff] [blame] | 17 | intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 18 | intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 19 | intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 20 | intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 21 | intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) |
thmsdt | 67ce52a | 2022-06-27 13:07:45 +0200 | [diff] [blame] | 22 | intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 23 | intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) |
Eric Debeau | 8403769 | 2021-10-06 19:54:57 +0200 | [diff] [blame] | 24 | intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 25 | intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 26 | intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 27 | intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) |
| 28 | intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 29 | intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1190a2f | 2022-03-15 15:21:49 +0100 | [diff] [blame] | 30 | intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) |
| 31 | intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | ef2ee3f | 2021-03-18 16:00:37 +0100 | [diff] [blame] | 32 | intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 33 | intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) |
thmsdt | 67ce52a | 2022-06-27 13:07:45 +0200 | [diff] [blame] | 34 | intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 35 | intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) |
| 36 | intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) |
| 37 | intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) |
| 38 | intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 39 | intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) |
thmsdt | 9d2461c | 2021-11-12 10:35:10 +0100 | [diff] [blame] | 40 | intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 41 | intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | cb391d0 | 2021-04-01 17:27:20 +0200 | [diff] [blame] | 42 | intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) |
thmsdt | 67ce52a | 2022-06-27 13:07:45 +0200 | [diff] [blame] | 43 | intersphinx_mapping['onap-oom-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 44 | intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 45 | intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | cb391d0 | 2021-04-01 17:27:20 +0200 | [diff] [blame] | 46 | intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) |
andreasgeissler | 3a170f7 | 2021-04-01 10:17:03 +0200 | [diff] [blame] | 47 | intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) |
| 48 | intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) |
| 49 | intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) |
| 50 | intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None) |
| 51 | intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) |
thmsdt | 67ce52a | 2022-06-27 13:07:45 +0200 | [diff] [blame] | 52 | intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) |
thmsdt | 1801ddf | 2022-03-15 17:40:26 +0100 | [diff] [blame] | 53 | |
thmsdt | 6458ba7 | 2022-06-27 16:45:45 +0200 | [diff] [blame] | 54 | # One exception for osa repo for Jakarta release only! For the Kohn release they are asked to create a branch! |
| 55 | branch = 'latest' |
| 56 | intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None) |
| 57 | |
thmsdt | 1cc31c3 | 2022-03-16 13:55:01 +0100 | [diff] [blame] | 58 | # Linkcheck |
Guillaume Lambert | 5b9d80a | 2021-02-02 15:07:08 +0100 | [diff] [blame] | 59 | linkcheck_ignore = [ |
Andrea Visnyei | 32d2daf | 2020-12-09 12:26:35 +0100 | [diff] [blame] | 60 | 'http://localhost', |
| 61 | 'https://example.com', |
Guillaume Lambert | 3931bb1 | 2021-02-17 11:48:28 +0100 | [diff] [blame] | 62 | '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 Lambert | 5b9d80a | 2021-02-02 15:07:08 +0100 | [diff] [blame] | 72 | ] |
Aric Gardner | 8a8832a | 2020-04-02 17:17:49 -0400 | [diff] [blame] | 73 | |
Rich Bennett | 80455a5 | 2017-11-08 05:17:00 -0500 | [diff] [blame] | 74 | html_last_updated_fmt = '%d-%b-%y %H:%M' |
Rich Bennett | 22ef085 | 2017-07-19 18:05:55 -0400 | [diff] [blame] | 75 | |
Rich Bennett | 317d81a | 2018-09-11 07:38:05 -0400 | [diff] [blame] | 76 | def setup(app): |
Guillaume Lambert | 3e25eeb | 2021-02-02 15:35:50 +0100 | [diff] [blame] | 77 | app.add_css_file("css/ribbon.css") |