| David Horstmann | 633a081 | 2023-03-14 16:38:36 +0000 | [diff] [blame] | 1 | # .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 |
| 6 | version: 2 |
| 7 | |
| 8 | # Set the version of Python and other tools you might need |
| 9 | build: |
| 10 | os: ubuntu-20.04 |
| 11 | tools: |
| 12 | python: "3.9" |
| 13 | jobs: |
| 14 | pre_build: |
| Bence Szépkúti | 7ce8fba | 2023-04-14 16:36:19 +0200 | [diff] [blame] | 15 | - make apidoc |
| 16 | - breathe-apidoc -o docs/api apidoc/xml |
| 17 | post_build: |
| Bence Szépkúti | 6a89a04 | 2023-05-09 20:11:51 +0200 | [diff] [blame^] | 18 | - | |
| 19 | if [ "$READTHEDOCS_VERSION" = "development" ]; then |
| 20 | "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml |
| 21 | fi |
| David Horstmann | 633a081 | 2023-03-14 16:38:36 +0000 | [diff] [blame] | 22 | |
| 23 | # Build documentation in the docs/ directory with Sphinx |
| 24 | sphinx: |
| 25 | builder: dirhtml |
| 26 | configuration: docs/conf.py |
| 27 | |
| 28 | # Optionally declare the Python requirements required to build your docs |
| 29 | python: |
| 30 | install: |
| 31 | - requirements: docs/requirements.txt |