docs/conf.py

   1 from docs_conf.conf import *
   2
   3 #branch configuration
   4 branch = 'latest'
   5
   6 linkcheck_ignore = [
   7       'http://localhost',
   8 ]
   9
  10 #intershpinx mapping with other projects
  11 intersphinx_mapping = {}
  12
  13 #(near realtime)RIC app
  14 intersphinx_mapping['ric-app-mc'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-mc/en/%s' % branch, None)
  15 intersphinx_mapping['ric-app-ml'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-ml/en/%s' % branch, None)
  16 intersphinx_mapping['com-gs-lite'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-com-gs-lite/en/%s' % branch, None)
  17 intersphinx_mapping['ric-app-admin'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-admin/en/%s' % branch, None)
  18 intersphinx_mapping['ric-app-kpimon'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-kpimon/en/%s' % branch, None)
  19 intersphinx_mapping['ric-plt-alarm-go'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-alarm-go/en/%s' % branch, None)
  20 intersphinx_mapping['ric-app-hw'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-hw/en/%s' % branch, None)
  21 intersphinx_mapping['ric-app-qp'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-qp/en/%s' % branch, None)
  22 intersphinx_mapping['ric-app-ts'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-ts/en/%s' % branch, None)
  23 intersphinx_mapping['ric-app-ad'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-ad/en/%s' % branch, None)
  24 intersphinx_mapping['ric-app-hw-go'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-hw-go/en/%s' % branch, None)
  25
  26
  27 #(near realtime)RIC platform
  28 intersphinx_mapping['com-log'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-com-log/en/%s' % branch, None)
  29 intersphinx_mapping['com-golog'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-com-golog/en/%s' % branch, None)
  30 intersphinx_mapping['com-pylog'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-com-pylog/en/%s' % branch, None)
  31 intersphinx_mapping['ric-plt-a1'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-a1/en/%s' % branch, None)
  32 intersphinx_mapping['ric-plt-appmgr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-appmgr/en/%s' % branch, None)
  33 intersphinx_mapping['ric-plt-dbaas'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-dbaas/en/%s' % branch, None)
  34 intersphinx_mapping['ric-plt-e2'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-e2/en/%s' % branch, None)
  35 intersphinx_mapping['ric-plt-e2mgr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-e2mgr/en/%s' % branch, None)
  36 intersphinx_mapping['ric-plt-nodeb-rnib'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-nodeb-rnib/en/%s' % branch, None)
  37 intersphinx_mapping['ric-plt-lib-rmr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/%s' % branch, None)
  38 intersphinx_mapping['ric-plt-rtmgr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-rtmgr/en/%s' % branch, None)
  39 intersphinx_mapping['ric-plt-sdl'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-sdl/en/%s' % branch, None)
  40 intersphinx_mapping['ric-plt-sdlgo'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-sdlgo/en/%s' % branch, None)
  41 intersphinx_mapping['ric-plt-submgr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-submgr/en/%s' % branch, None)
  42 intersphinx_mapping['ric-plt-jaegeradapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-jaegeradapter/en/%s' % branch, None)
  43 intersphinx_mapping['ric-plt-tracelibcpp'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-tracelibcpp/en/%s' % branch, None)
  44 intersphinx_mapping['ric-plt-tracelibgo'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-tracelibgo/en/%s' % branch, None)
  45 intersphinx_mapping['ric-plt-vespamgr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-vespamgr/en/%s' % branch, None)
  46 intersphinx_mapping['ric-plt-xapp-frame'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-xapp-frame/en/%s' % branch, None)
  47 intersphinx_mapping['ric-plt-asn1-documents'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-asn1-documents/en/%s' % branch, None)
  48 intersphinx_mapping['ric-plt-streaming-protobufs'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-streaming-protobufs/en/%s' % branch, None)
  49 intersphinx_mapping['ric-plt-resource-status-manager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-resource-status-manager/en/%s' % branch, None)
  50 intersphinx_mapping['ric-plt-xapp-frame'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-xapp-frame/en/%s' % branch, None)
  51 intersphinx_mapping['ric-plt-xapp-frame-py'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-xapp-frame-py/en/%s' % branch, None)
  52 intersphinx_mapping['ric-plt-xapp-frame-cpp'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-xapp-frame-cpp/en/%s' % branch, None)
  53
  54
  55 #nonrt ric
  56 intersphinx_mapping['nonrtric'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % branch, None)
  57 intersphinx_mapping['nonrtric-controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % branch, None)
  58 intersphinx_mapping['sim-a1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % branch, None)
  59
  60
  61 #OAM
  62 intersphinx_mapping['oam'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-oam/en/%s' % branch, None)
  63 intersphinx_mapping['portal-ric-dashboard'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-ric-dashboard/en/%s' % branch, None)
  64 intersphinx_mapping['oam-tr069-adapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-oam-tr069-adapter/en/%s' % branch, None)
  65 intersphinx_mapping['oam-nf-oam-adopter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-oam-nf-oam-adopter/en/%s' % branch, None)
  66
  67
  68 #OCU
  69 #intersphinx_mapping['scp-ocu-openlte'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-scp-ocu-openlte/en/%s' % branch, None)
  70 intersphinx_mapping['scp-ocu-5gnr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-scp-ocu-5gnr/en/%s' % branch, None)
  71
  72
  73 #ODUHIGH
  74 intersphinx_mapping['o-du-l2'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-l2/en/%s' % branch, None)
  75
  76
  77 #ODULOW
  78 intersphinx_mapping['o-du-phy'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/%s' % branch, None)
  79
  80
  81 #INF
  82 intersphinx_mapping['pti-rtp'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-pti-rtp/en/%s' % branch, None)
  83 intersphinx_mapping['pti-o2'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-pti-o2/en/%s' % branch, None)
  84
  85
  86 #SIM
  87 intersphinx_mapping['sim-o1-interface'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-o1-interface/en/%s' % branch, None)
  88
  89
  90 #INT
  91 intersphinx_mapping['it-dep'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/%s' % branch, None)
  92 intersphinx_mapping['it-dev'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-it-dev/en/%s' % branch, None)
  93 intersphinx_mapping['it-test'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-it-test/en/%s' % branch, None)
  94 intersphinx_mapping['it-otf'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-it-otf/en/%s' % branch, None)
  95
  96
  97 #SMO
  98 intersphinx_mapping['smo-ves'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-smo-ves/en/%s' % branch, None)
  99 intersphinx_mapping['smo-o1'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-smo-o1/en/%s' % branch, None)
 100 intersphinx_mapping['smo-o2'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-smo-o2/en/%s' % branch, None)
 101
 102 #AIMLFW
 103 intersphinx_mapping['aiml-fw-awmf-tm'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-awmf-tm/en/%s' % branch, None)
 104 intersphinx_mapping['portal-aiml-dashboard'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-aiml-dashboard/en/%s' % branch, None)
 105 intersphinx_mapping['aiml-fw-athp-data-extraction'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-athp-data-extraction/en/%s' % branch, None)
 106 intersphinx_mapping['aiml-fw-athp-sdk-feature-store'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-athp-sdk-feature-store/en/%s' % branch, None)
 107 intersphinx_mapping['aiml-fw-athp-sdk-model-storage'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-athp-sdk-model-storage/en/%s' % branch, None)
 108 intersphinx_mapping['aiml-fw-athp-tps-kubeflow-adapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-athp-tps-kubeflow-adapter/en/%s' % branch, None)
 109 intersphinx_mapping['aiml-fw-aimlfw-dep'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-aiml-fw-aimlfw-dep/en/%s' % branch, None)
 110 intersphinx_mapping['ric-app-qp-aimlfw'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-app-qp-aimlfw/en/%s' % branch, None)
 111
 112
 113