docs/conf.py

   1 #  ============LICENSE_START===============================================
   2 #  Copyright (C) 2019-2023 Nordix Foundation. All rights reserved.
   3 #  Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved.
   4 #  ========================================================================
   5 #  Licensed under the Apache License, Version 2.0 (the "License");
   6 #  you may not use this file except in compliance with the License.
   7 #  You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #  Unless required by applicable law or agreed to in writing, software
  12 #  distributed under the License is distributed on an "AS IS" BASIS,
  13 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #  See the License for the specific language governing permissions and
  15 #  limitations under the License.
  16 #  ============LICENSE_END=================================================
  17
  18 from docs_conf.conf import *
  19
  20 ## Update here to configure which branch is used.
  21 #branch configurations
  22 controlpanelbranch = 'latest'
  23 simulatorbranch = 'latest'
  24 dmaapmediatorproducerbranch = 'latest'
  25 dmaapadapterbranch = 'latest'
  26 informationcoordinatorservicebranch = 'latest'
  27 rappcataloguebranch = 'latest'
  28 rappmanagerbranch = 'latest'
  29 helmmanagerbranch = 'latest'
  30 ransliceassurancebranch = 'latest'
  31 orufhrecoverybranch = 'latest'
  32 authtokenfetchbranch = 'latest'
  33 a1policymanagementservicebranch = 'latest'
  34 smebranch = 'latest'
  35 ranpmbranch = 'latest'
  36 onapbranch = 'latest'
  37 # Add some useful links available in every page
  38 rst_epilog = """
  39 .. _nonrtricwiki: https://wiki.o-ran-sc.org/display/RICNR/
  40 .. _nonrtricwikidevguide: https://wiki.o-ran-sc.org/display/RICNR/Release+I
  41 .. _nonrtricwikik8s: https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Kubernetes
  42 .. _nonrtricwikidocker: https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Docker
  43 """
  44 ##
  45
  46
  47 linkcheck_ignore = [
  48     'http://localhost.*',
  49     'http://127.0.0.1.*',
  50     'https://gerrit.o-ran-sc.org.*',
  51 ]
  52
  53 extensions = [
  54     'sphinx.ext.intersphinx',
  55     'sphinx.ext.autosectionlabel',
  56 ]
  57
  58 #intershpinx mapping with other projects
  59 intersphinx_mapping = {}
  60
  61 intersphinx_mapping['controlpanel'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/%s' % controlpanelbranch, None)
  62 intersphinx_mapping['simulator'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/%s' % simulatorbranch, None)
  63 intersphinx_mapping['dmaapmediatorproducer'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapmediatorproducer/en/%s' % dmaapmediatorproducerbranch, None)
  64 intersphinx_mapping['dmaapadapter'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-dmaapadapter/en/%s' % dmaapadapterbranch, None)
  65 intersphinx_mapping['informationcoordinatorservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' % informationcoordinatorservicebranch, None)
  66 intersphinx_mapping['rappcatalogue'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappcatalogue/en/%s' % rappcataloguebranch, None)
  67 intersphinx_mapping['rappmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappmanager/en/%s' % rappmanagerbranch, None)
  68 intersphinx_mapping['helmmanager'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-helmmanager/en/%s' % helmmanagerbranch, None)
  69 intersphinx_mapping['ransliceassurance'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-ransliceassurance/en/%s' % ransliceassurancebranch, None)
  70 intersphinx_mapping['orufhrecovery'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-rapp-orufhrecovery/en/%s' % orufhrecoverybranch, None)
  71 intersphinx_mapping['authtokenfetch'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % authtokenfetchbranch, None)
  72 intersphinx_mapping['a1policymanagementservice'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-a1policymanagementservice/en/%s' % a1policymanagementservicebranch, None)
  73 intersphinx_mapping['sme'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-sme/en/%s' % smebranch, None)
  74 intersphinx_mapping['ranpm'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % ranpmbranch, None)
  75 intersphinx_mapping['onapa1policymanagementservice'] = ('https://docs.onap.org/projects/onap-ccsdk-oran/en/%s' % onapbranch, None)