docs/conf.py

   1 # Copyright (C) 2022 Wind River Systems, Inc.
   2 #
   3 #  Licensed under the Apache License, Version 2.0 (the "License");
   4 #  you may not use this file except in compliance with the License.
   5 #  You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14 from docs_conf.conf import *
  15
  16 linkcheck_ignore = [
  17     'http://localhost.*',
  18     'http://127.0.0.1.*',
  19     'https://gerrit.o-ran-sc.org.*',
  20     'http://put_your_*',
  21     './oran-o2-api.html',  # Generated file that doesn't exist at link check.
  22     './api-docs.html'
  23 ]
  24
  25 extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx']
  26
  27 redoc = [
  28     {
  29         'name': 'O-RAN O2 API',
  30                 'page': 'oran-o2-api',
  31                 'spec': './swagger.json',
  32                 'embed': True,
  33     }
  34 ]
  35
  36 redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
  37
  38 # intershpinx mapping with other projects
  39 # intersphinx_mapping = {}