X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=43c126d3ec0b7a4a8245e477a332dc7750fdbc25;hb=7dc96e95bb2354ac4cfd4b2947960437ce20b72e;hp=4ee69983335476c5648b5a224f03b7055e4716e4;hpb=237a4da4b9419171f774bd6a02f61bef81f1b60f;p=nonrtric.git diff --git a/docs/conf.py b/docs/conf.py index 4ee69983..43c126d3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,50 +2,40 @@ 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' +a1policymanagementservicebranch = '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. - './ics-api.html', #Generated file that doesn't exist at link check. - './dmaap-adaptor-api.html' #Generated file that doesn't exist at link check. - './dmaap-mediator-producer-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': 'ICS API', - 'page': 'ics-api', - 'spec': '../information-coordinator-service/api/ics-api.json', - 'embed': True, - }, - { - 'name': 'DMaaP Adaptor API', - 'page': 'dmaap-adaptor-api', - 'spec': '../dmaap-adaptor-java/api/api.json', - }, - { - 'name': 'DMaaP Mediator Producer API', - 'page': 'dmaap-mediator-producer-api', - 'spec': '../dmaap-mediator-producer/api/swagger.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['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % a1policymanagementservicebranch, None) +intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None)