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 ]
  15
  16 extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
  17
  18 redoc = [
  19             {
  20                 'name': 'RAC API',
  21                 'page': 'rac-api',
  22                 'spec': '../r-app-catalogue/api/rac-api.json',
  23                 'embed': True,
  24             },
  25             {
  26                 'name': 'ICS API',
  27                 'page': 'ics-api',
  28                 'spec': '../information-coordinator-service/api/ics-api.json',
  29                 'embed': True,
  30             },
  31             {
  32                 'name': 'DMaaP Adaptor API',
  33                 'page': 'dmaap-adaptor-api',
  34                 'spec': '../dmaap-adaptor-java/api/api.json',
  35                 'embed': True,
  36             }
  37         ]
  38
  39 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
  40
  41 #intershpinx mapping with other projects
  42 intersphinx_mapping = {}
  43
  44 intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None)
  45 intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None)