docs/conf.py

   1 #  ============LICENSE_START======================================================================
   2 #  Copyright (C) 2023 OpenInfra Foundation Europe. 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 from docs_conf.conf import *
  18
  19 #branch configuration
  20
  21 branch = 'i-release'
  22 baseurl = 'https://docs.o-ran-sc.org/projects/'
  23 selfurl = '%s/o-ran-sc-nonrtric-plt-rappmanager/en/%s' %(baseurl, branch)
  24
  25 linkcheck_ignore = [
  26     'http://localhost.*',
  27     'http://127.0.0.1.*',
  28     'https://gerrit.o-ran-sc.org.*',
  29     '.*participants.*',  # Participants site may not be built yet
  30     './rappmanager-api.html', # Generated file that doesn't exist at link check.
  31 ]
  32
  33 extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
  34
  35 redoc = [
  36             {
  37                 'name': 'rApp Manager API',
  38                 'page': 'rappmanager-api',
  39                 'spec': '../openapi/rappmanager/rappmanager-spec.yaml',
  40                 'embed': True,
  41             }
  42         ]
  43
  44 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
  45
  46 #intershpinx mapping with other projects
  47 intersphinx_mapping = {}
  48
  49 intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branch), None)
  50 #intersphinx_mapping['participants'] = ('%s/participants' % selfurl, None)
  51 intersphinx_disabled_reftypes = ["*"]