docs/conf.py

   1 #  ============LICENSE_START===============================================
   2 #  Copyright (C) 2021-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
  19 # NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedocs.yaml')
  20 #     Where possible include contents of the sub-folders' 'conf.yaml' files here if appropriate
  21
  22 from docs_conf.conf import *
  23
  24 branch = 'latest'
  25 subsitesbranch = 'latest' # set this to latest for the first build on a new branch. Then change in next commit.
  26 icsbranch = 'latest'
  27
  28 baseurl = 'https://docs.o-ran-sc.org/projects/'
  29 selfurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, branch)
  30 subsitesurl = '%s/o-ran-sc-nonrtric-plt-ranpm/en/%s' %(baseurl, subsitesbranch)
  31 icsurl = '%s/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/%s' %(baseurl, subsitesbranch)
  32
  33
  34 linkcheck_ignore = [
  35     'http://localhost.*',
  36     'http://127.0.0.1.*',
  37     'https://gerrit.o-ran-sc.org.*'
  38 ]
  39
  40 extensions = [
  41     'sphinx.ext.intersphinx',
  42     'sphinx.ext.autosectionlabel',
  43 ]
  44
  45 #intershpinx mapping with other projects
  46 intersphinx_mapping = {}
  47 intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branch), None)
  48 ## Note there is a circular dependency here - sub-project pages must exist before they can be checked
  49 intersphinx_mapping['influxlogger'] = ('%s/influxlogger' %subsitesurl, None)
  50 intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' %subsitesurl, None)
  51 intersphinx_mapping['pmproducer'] = ('%s/pmproducer' %subsitesurl, None)
  52 intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' %subsitesurl, None)
  53 intersphinx_mapping['ics'] = ('%s' %icsurl, None)
  54
  55 intersphinx_disabled_reftypes = ["*"]