Add docker-compose file for odu-app
[nonrtric.git] / docs / conf.py
1 from docs_conf.conf import *
2
3 #branch configuration
4
5 branch = 'latest'
6
7 linkcheck_ignore = [
8     'http://localhost.*',
9     'http://127.0.0.1.*',
10     'https://gerrit.o-ran-sc.org.*',
11     './rac-api.html', #Generated file that doesn't exist at link check.
12     './ics-api.html', #Generated file that doesn't exist at link check.
13     './dmaap-adaptor-api.html' #Generated file that doesn't exist at link check.
14     './dmaap-mediator-producer-api.html' #Generated file that doesn't exist at link check.
15 ]
16
17 extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
18
19 redoc = [
20             {
21                 'name': 'RAC API',
22                 'page': 'rac-api',
23                 'spec': '../r-app-catalogue/api/rac-api.json',
24                 'embed': True,
25             },
26             {
27                 'name': 'ICS API',
28                 'page': 'ics-api',
29                 'spec': '../information-coordinator-service/api/ics-api.json',
30                 'embed': True,
31             },
32             {
33                 'name': 'DMaaP Adaptor API',
34                 'page': 'dmaap-adaptor-api',
35                 'spec': '../dmaap-adaptor-java/api/api.json',
36             },
37             {
38                 'name': 'DMaaP Mediator Producer API',
39                 'page': 'dmaap-mediator-producer-api',
40                 'spec': '../dmaap-mediator-producer/api/swagger.json',
41                 'embed': True,
42             }
43         ]
44
45 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
46
47 #intershpinx mapping with other projects
48 intersphinx_mapping = {}
49
50 intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None)
51 intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None)