2023-03-14 17:38:36 +01:00
|
|
|
# .readthedocs.yaml
|
|
|
|
|
# Read the Docs configuration file
|
|
|
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
|
|
|
|
|
|
# Required
|
|
|
|
|
version: 2
|
|
|
|
|
|
|
|
|
|
# Set the version of Python and other tools you might need
|
|
|
|
|
build:
|
|
|
|
|
os: ubuntu-20.04
|
|
|
|
|
tools:
|
|
|
|
|
python: "3.9"
|
|
|
|
|
jobs:
|
|
|
|
|
pre_build:
|
2023-04-14 16:36:19 +02:00
|
|
|
- make apidoc
|
|
|
|
|
- breathe-apidoc -o docs/api apidoc/xml
|
|
|
|
|
post_build:
|
|
|
|
|
- '[ "$READTHEDOCS_VERSION" != "development" ] || "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml'
|
|
|
|
|
|
2023-03-14 17:38:36 +01:00
|
|
|
|
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
|
|
|
sphinx:
|
|
|
|
|
builder: dirhtml
|
|
|
|
|
configuration: docs/conf.py
|
|
|
|
|
|
|
|
|
|
# Optionally declare the Python requirements required to build your docs
|
|
|
|
|
python:
|
|
|
|
|
install:
|
|
|
|
|
- requirements: docs/requirements.txt
|
