X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pmproducer%2Fdocs%2Fconf.py;fp=pmproducer%2Fdocs%2Fconf.py;h=ca7bb8f3adcb1b029d7bae34031aea2319451078;hb=608883c0d1a053280151772144798311f3699909;hp=0000000000000000000000000000000000000000;hpb=db5cb9a3759fe227ce8654bd0be1c85080e83e3f;p=nonrtric%2Fplt%2Franpm.git diff --git a/pmproducer/docs/conf.py b/pmproducer/docs/conf.py new file mode 100644 index 0000000..ca7bb8f --- /dev/null +++ b/pmproducer/docs/conf.py @@ -0,0 +1,48 @@ +# ============LICENSE_START=============================================== +# Copyright (C) 2021-2022 Nordix Foundation. All rights reserved. +# ======================================================================== +# 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. +# ============LICENSE_END================================================= +# + +from docs_conf.conf import * + +#branch configuration + +branch = 'latest' + +language = 'en' + +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*', + './pm-producer-api.html', #Generated file that doesn't exist at link check. +] + +extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',] + +redoc = [ + { + 'name': 'PM Producer API', + 'page': 'pm-producer-api', + 'spec': '../api/api.json', + } + ] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + +#intershpinx mapping with other projects +intersphinx_mapping = {} + +intersphinx_mapping['nonrtric'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/%s' % branch, None)