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