1*cfb92d14SAndroid Build Coastguard Worker# .readthedocs.yaml 2*cfb92d14SAndroid Build Coastguard Worker# Read the Docs configuration file 3*cfb92d14SAndroid Build Coastguard Worker# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 4*cfb92d14SAndroid Build Coastguard Worker 5*cfb92d14SAndroid Build Coastguard Worker# Required 6*cfb92d14SAndroid Build Coastguard Workerversion: 2 7*cfb92d14SAndroid Build Coastguard Worker 8*cfb92d14SAndroid Build Coastguard Worker# Include the framework submodule in the build 9*cfb92d14SAndroid Build Coastguard Workersubmodules: 10*cfb92d14SAndroid Build Coastguard Worker include: 11*cfb92d14SAndroid Build Coastguard Worker - framework 12*cfb92d14SAndroid Build Coastguard Worker 13*cfb92d14SAndroid Build Coastguard Worker# Set the version of Python and other tools you might need 14*cfb92d14SAndroid Build Coastguard Workerbuild: 15*cfb92d14SAndroid Build Coastguard Worker os: ubuntu-20.04 16*cfb92d14SAndroid Build Coastguard Worker tools: 17*cfb92d14SAndroid Build Coastguard Worker python: "3.9" 18*cfb92d14SAndroid Build Coastguard Worker jobs: 19*cfb92d14SAndroid Build Coastguard Worker pre_build: 20*cfb92d14SAndroid Build Coastguard Worker - ./scripts/apidoc_full.sh 21*cfb92d14SAndroid Build Coastguard Worker - breathe-apidoc -o docs/api apidoc/xml 22*cfb92d14SAndroid Build Coastguard Worker post_build: 23*cfb92d14SAndroid Build Coastguard Worker - | 24*cfb92d14SAndroid Build Coastguard Worker # Work around Readthedocs bug: Command parsing fails if the 'if' statement is on the first line 25*cfb92d14SAndroid Build Coastguard Worker if [ "$READTHEDOCS_VERSION" = "development" ]; then 26*cfb92d14SAndroid Build Coastguard Worker "$READTHEDOCS_VIRTUALENV_PATH/bin/rtd" projects "Mbed TLS API" redirects sync --wet-run -f docs/redirects.yaml 27*cfb92d14SAndroid Build Coastguard Worker fi 28*cfb92d14SAndroid Build Coastguard Worker 29*cfb92d14SAndroid Build Coastguard Worker# Build documentation in the docs/ directory with Sphinx 30*cfb92d14SAndroid Build Coastguard Workersphinx: 31*cfb92d14SAndroid Build Coastguard Worker builder: dirhtml 32*cfb92d14SAndroid Build Coastguard Worker configuration: docs/conf.py 33*cfb92d14SAndroid Build Coastguard Worker 34*cfb92d14SAndroid Build Coastguard Worker# Optionally declare the Python requirements required to build your docs 35*cfb92d14SAndroid Build Coastguard Workerpython: 36*cfb92d14SAndroid Build Coastguard Worker install: 37*cfb92d14SAndroid Build Coastguard Worker - requirements: docs/requirements.txt 38