blob: 72f126fa20ad06a2b6c9aee0d9ab600c81a2a47c [file] [log] [blame]
David Horstmann633a0812023-03-14 16:38:36 +00001# .readthedocs.yaml
2# Read the Docs configuration file
3# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
5# Required
6version: 2
7
8# Set the version of Python and other tools you might need
9build:
10 os: ubuntu-20.04
11 tools:
12 python: "3.9"
13 jobs:
14 pre_build:
David Horstmann84fccd42023-06-13 10:27:42 +010015 - ./scripts/apidoc_full.sh
Bence Szépkúti7ce8fba2023-04-14 16:36:19 +020016 - breathe-apidoc -o docs/api apidoc/xml
17 post_build:
Bence Szépkúti6a89a042023-05-09 20:11:51 +020018 - |
Bence Szépkúti71f41de2023-05-09 20:11:51 +020019 # Work around Readthedocs bug: Command parsing fails if the 'if' statement is on the first line
Bence Szépkúti6a89a042023-05-09 20:11:51 +020020 if [ "$READTHEDOCS_VERSION" = "development" ]; then
21 "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml
22 fi
David Horstmann633a0812023-03-14 16:38:36 +000023
24# Build documentation in the docs/ directory with Sphinx
25sphinx:
26 builder: dirhtml
27 configuration: docs/conf.py
28
29# Optionally declare the Python requirements required to build your docs
30python:
31 install:
32 - requirements: docs/requirements.txt