X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=c5e504d8006afa6b9001465e3464e85633c8630f;hb=8fae7155fc1c92f8a7ff283bc14e9f9df3da88d3;hp=922e22fb470dc6c162b0c5024091fadf014ff69a;hpb=c59ec164cad614c51c70e385b85fd1d04ef86d1d;p=nonrtric.git diff --git a/docs/conf.py b/docs/conf.py index 922e22fb..c5e504d8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,45 @@ from docs_conf.conf import * + +#branch configuration + +branch = 'latest' + linkcheck_ignore = [ 'http://localhost.*', 'http://127.0.0.1.*', - 'https://gerrit.o-ran-sc.org.*' + '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. ] + +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', + 'embed': True, + } + ] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + +#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)