influxlogger/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 from docs_conf.conf import *
  20
  21 branch = 'latest'
  22
  23 linkcheck_ignore = [
  24     'http://localhost.*',
  25     'http://127.0.0.1.*',
  26     'https://gerrit.o-ran-sc.org.*',
  27     './pmlog-api.html', #Generated file that doesn't exist at link check.
  28 ]
  29
  30 extensions = ['sphinx.ext.intersphinx','sphinxcontrib.redoc', 'sphinx.ext.autosectionlabel',]
  31
  32 redoc = [
  33             {
  34                 'name': 'Influx Logger API',
  35                 'page': 'pmlog-api',
  36                 'spec': '../api/pmlog-api.json',
  37                 'embed': True,
  38             }
  39         ]
  40
  41 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
  42
  43 #intershpinx mapping with other projects
  44 intersphinx_mapping = {}
  45
  46 intersphinx_mapping['nonrtric'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % branch, None)