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     './ecs-api.html' #Generated file that doesn't exist at link check.
  13 ]
  14
  15 extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
  16
  17 redoc = [
  18             {
  19                 'name': 'RAC API',
  20                 'page': 'rac-api',
  21                 'spec': '../r-app-catalogue/api/rac-api.json',
  22                 'embed': True,
  23             },
  24             {
  25                 'name': 'ECS API',
  26                 'page': 'ecs-api',
  27                 'spec': '../enrichment-coordinator-service/api/ecs-api.json',
  28                 'embed': True,
  29             }
  30         ]
  31
  32 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
  33
  34 #intershpinx mapping with other projects
  35 intersphinx_mapping = {}
  36
  37 intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None)
  38 intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None)