Documentation updates
[nonrtric/plt/ranpm.git] / .readthedocs.yaml
1 #  ============LICENSE_START===============================================
2 #  Copyright (C) 2020-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 ---
19 # .readthedocs.yml
20 # Read the Docs configuration file
21 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
22
23 version: 2
24
25 formats:
26   - htmlzip
27
28 build:
29   os: ubuntu-22.04
30   tools:
31     python: "3.7"
32   jobs:
33     pre_build:
34       - mkdir --parents _readthedocs/html/
35       - mkdir --parents _readthedocs/tmp/doctrees
36       - sphinx-build -W -b html --keep-going -n -d
37         _readthedocs/tmp/doctrees  ./docs/ _readthedocs/html/
38       - sphinx-build -W -b html --keep-going -n -d
39         _readthedocs/tmp/doctrees/datafilecollector  ./datafilecollector/docs/
40         _readthedocs/html/datafilecollector
41       - sphinx-build -W -b html --keep-going -n -d
42         _readthedocs/tmp/doctrees/influxlogger  ./influxlogger/docs/
43         _readthedocs/html/influxlogger
44       - sphinx-build -W -b html --keep-going -n -d
45         _readthedocs/tmp/doctrees/pmproducer  ./pmproducer/docs/
46         _readthedocs/html/pmproducer
47       - sphinx-build -W -b html --keep-going -n -d
48         _readthedocs/tmp/doctrees/pm-file-converter  ./pm-file-converter/docs/
49         _readthedocs/html/pm-file-converter
50
51 python:
52   install:
53     - requirements: docs/requirements-docs.txt
54     - requirements: datafilecollector/docs/requirements-docs.txt
55     - requirements: influxlogger/docs/requirements-docs.txt
56     - requirements: pmproducer/docs/requirements-docs.txt
57     - requirements: pm-file-converter/docs/requirements-docs.txt
58
59 sphinx:
60   configuration: docs/conf.py