Add ReadTheDocs configuration/site in repo root directory step #3c
[nonrtric/plt/ranpm.git] / docs / conf.py
1 #  ============LICENSE_START===============================================
2 #  Copyright (C) 2021-2023 Nordix Foundation. 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
18 # NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedocs.yaml') 
19 #     Where possible include contents of the sub-folders' 'conf.yaml' files here if appropriate
20
21 from docs_conf.conf import *
22
23 branch = 'latest'
24 selfurl = 'https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/%s' % branch
25
26 linkcheck_ignore = [
27     'http://localhost.*',
28     'http://127.0.0.1.*',
29     'https://gerrit.o-ran-sc.org.*'
30 ]
31
32 extensions = [
33     'sphinx.ext.intersphinx',
34     'sphinx.ext.autosectionlabel',
35 ]
36
37 #intershpinx mapping with other projects
38 #intersphinx_mapping = {}
39 ## Note there is a circular dependency here - sub-project pages must exist before they can be checked
40 #intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None)
41 #intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None)
42 #intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None)
43
44
45 intersphinx_disabled_reftypes = ["*"]