blob: 21bfee917a40e7ace030a6ecbef811adaedfbb05 [file] [log] [blame]
maximessone6b4d272019-10-31 13:26:13 +01001from docs_conf.conf import *
elinuxhenrik0a4c38b2020-04-14 10:59:36 +02002
3#branch configuration
4
5branch = 'latest'
6
maximessone6b4d272019-10-31 13:26:13 +01007linkcheck_ignore = [
8 'http://localhost.*',
9 'http://127.0.0.1.*',
elinuxhenrik5ada5152020-10-19 10:39:59 +020010 'https://gerrit.o-ran-sc.org.*',
PatrikBuhrcddb8132021-12-01 11:02:19 +010011 './ics-api.html', #Generated file that doesn't exist at link check.
elinuxhenrikf93f9af2022-02-17 16:28:01 +010012 './dmaap-adaptor-api.html', #Generated file that doesn't exist at link check.
elinuxhenrik6b45b052022-01-12 16:12:45 +010013 './dmaap-mediator-producer-api.html' #Generated file that doesn't exist at link check.
maximessone6b4d272019-10-31 13:26:13 +010014]
elinuxhenrik0a4c38b2020-04-14 10:59:36 +020015
elinuxhenrik5ada5152020-10-19 10:39:59 +020016extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
17
18redoc = [
19 {
elinuxhenrik29804372021-12-01 07:36:37 +010020 'name': 'ICS API',
21 'page': 'ics-api',
PatrikBuhrc6916032021-11-22 16:12:27 +010022 'spec': '../information-coordinator-service/api/ics-api.json',
elinuxhenrik6208ce82020-11-18 15:15:07 +010023 'embed': True,
PatrikBuhrcddb8132021-12-01 11:02:19 +010024 },
25 {
26 'name': 'DMaaP Adaptor API',
27 'page': 'dmaap-adaptor-api',
28 'spec': '../dmaap-adaptor-java/api/api.json',
elinuxhenrik5ada5152020-10-19 10:39:59 +020029 }
30 ]
31
32redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
33
elinuxhenrik0a4c38b2020-04-14 10:59:36 +020034#intershpinx mapping with other projects
35intersphinx_mapping = {}
36
37intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None)
38intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None)