X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=036bca6c0308d5aed5663e70546f4708c79f8fa2;hb=b593154ee3bcca6835e768e7d8336d0837530434;hp=ff5fcc9904230e81913e8241db46c1c1422d2178;hpb=3deeefa87a81f8724520ce0e3a55d88a5d328204;p=nonrtric.git diff --git a/docs/conf.py b/docs/conf.py index ff5fcc99..036bca6c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,38 +1,63 @@ +# ============LICENSE_START=============================================== +# Copyright (C) 2019-2022 Nordix Foundation. All rights reserved. +# ======================================================================== +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ============LICENSE_END================================================= + from docs_conf.conf import * #branch configuration -branch = 'latest' +controlpanelbranch = 'latest' +simulatorbranch = 'latest' +dmaapmediatorproducerbranch = 'latest' +dmaapadapterbranch = 'latest' +informationcoordinatorservicebranch = 'latest' +rappcataloguebranch = 'latest' +helmmanagerbranch = 'latest' +ransliceassurancebranch = 'latest' +orufhrecoverybranch = 'latest' +authtokenfetchbranch = 'latest' +a1policymanagementservicebranch = 'latest' +smebranch = 'latest' +ranpmbranch = 'latest' +onapbranch = 'latest' linkcheck_ignore = [ 'http://localhost.*', 'http://127.0.0.1.*', 'https://gerrit.o-ran-sc.org.*', - './rac-api.html', #Generated file that doesn't exist at link check. - './ecs-api.html' #Generated file that doesn't exist at link check. ] -extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',] - -redoc = [ - { - 'name': 'RAC API', - 'page': 'rac-api', - 'spec': '../r-app-catalogue/api/rac-api.json', - 'embed': True, - }, - { - 'name': 'ECS API', - 'page': 'ecs-api', - 'spec': '../information-coordinator-service/api/ics-api.json', - 'embed': True, - } - ] - -redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel', +] #intershpinx mapping with other projects intersphinx_mapping = {} -intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None) -intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None) +intersphinx_mapping['controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % controlpanelbranch, None) +intersphinx_mapping['simulator'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % simulatorbranch, None) +intersphinx_mapping['dmaapmediatorproducer'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer/en/%s' % dmaapmediatorproducerbranch, None) +intersphinx_mapping['dmaapadapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/%s' % dmaapadapterbranch, None) +intersphinx_mapping['informationcoordinatorservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' % informationcoordinatorservicebranch, None) +intersphinx_mapping['rappcatalogue'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue/en/%s' % rappcataloguebranch, None) +intersphinx_mapping['helmmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager/en/%s' % helmmanagerbranch, None) +intersphinx_mapping['ransliceassurance'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance/en/%s' % ransliceassurancebranch, None) +intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-orufhrecovery/en/%s' % orufhrecoverybranch, None) +intersphinx_mapping['authtokenfetch'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % authtokenfetchbranch, None) +intersphinx_mapping['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % a1policymanagementservicebranch, None) +intersphinx_mapping['sme'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-sme/en/%s' % smebranch, None) +intersphinx_mapping['ranpm'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % ranpmbranch, None) +intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None)