docs/conf.py

   1 #  ============LICENSE_START===============================================
   2 #  Copyright (C) 2021-2023 Nordix Foundation. All rights reserved.
   3 #  ========================================================================
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 #  ============LICENSE_END=================================================
  16 #
  17
  18 # NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedocs.yaml')
  19 #     Where possible include contents of the sub-folders' 'conf.yaml' files here if appropriate
  20
  21 from docs_conf.conf import *
  22
  23 branch = 'latest'
  24 baseurl = 'https://docs.o-ran-sc.org/projects/'
  25 selfurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, branch)
  26
  27 linkcheck_ignore = [
  28     'http://localhost.*',
  29     'http://127.0.0.1.*',
  30     'https://gerrit.o-ran-sc.org.*'
  31 ]
  32
  33 extensions = [
  34     'sphinx.ext.intersphinx',
  35     'sphinx.ext.autosectionlabel',
  36 ]
  37
  38 #intershpinx mapping with other projects
  39 intersphinx_mapping = {}
  40 intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branch), None)
  41 ## Note there is a circular dependency here - sub-project pages must exist before they can be checked
  42 intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None)
  43 intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None)
  44 intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None)
  45 intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None)
  46
  47 intersphinx_disabled_reftypes = ["*"]