X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=2f37573b53647034d579cf7a6c6ac58b5c52de8e;hb=c2097479bbdfae35b77415d7feb47a3f56f308f1;hp=922e22fb470dc6c162b0c5024091fadf014ff69a;hpb=b37a7d8e36bd9fdf862cb1aad29f9a29052e725f;p=pti%2Fo2.git diff --git a/docs/conf.py b/docs/conf.py index 922e22f..2f37573 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,39 @@ +# Copyright (C) 2022 Wind River Systems, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. from docs_conf.conf import * + linkcheck_ignore = [ 'http://localhost.*', 'http://127.0.0.1.*', - 'https://gerrit.o-ran-sc.org.*' + 'https://gerrit.o-ran-sc.org.*', + 'http://put_your_*', + './oran-o2-api.html', # Generated file that doesn't exist at link check. + './api-docs.html' ] + +extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx'] + +redoc = [ + { + 'name': 'O-RAN O2 API', + 'page': 'oran-o2-api', + 'spec': './swagger.json', + 'embed': True, + } +] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + +# intershpinx mapping with other projects +# intersphinx_mapping = {}