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