| Tom Rini | 0344c60 | 2024-10-08 13:56:50 -0600 | [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 | # Include the framework submodule in the build |
| 9 | submodules: |
| 10 | include: |
| 11 | - framework |
| 12 | |
| 13 | # Set the version of Python and other tools you might need |
| 14 | build: |
| 15 | os: ubuntu-20.04 |
| 16 | tools: |
| 17 | python: "3.9" |
| 18 | jobs: |
| 19 | pre_build: |
| 20 | - ./scripts/apidoc_full.sh |
| 21 | - breathe-apidoc -o docs/api apidoc/xml |
| 22 | post_build: |
| 23 | - | |
| 24 | # Work around Readthedocs bug: Command parsing fails if the 'if' statement is on the first line |
| 25 | if [ "$READTHEDOCS_VERSION" = "development" ]; then |
| 26 | "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml |
| 27 | fi |
| 28 | |
| 29 | # Build documentation in the docs/ directory with Sphinx |
| 30 | sphinx: |
| 31 | builder: dirhtml |
| 32 | configuration: docs/conf.py |
| 33 | |
| 34 | # Optionally declare the Python requirements required to build your docs |
| 35 | python: |
| 36 | install: |
| 37 | - requirements: docs/requirements.txt |