arm-trusted-firmware/.readthedocs.yaml
Harrison Mutai 5383a88b93 fix(docs): point poetry readthedocs virtual env
RTD uses a mixture of poetry and pip to install packages in the build
environment. In the past it was recommended to disable poetry from
creating a fresh virtual environment. Instead, the expectation was that
poetry would be able to detect it's current virtual environment and
install the packages in the right place. This was recently updated to
allow poetry to better allow dependcy management by poetry [1]. Remove
this configuration and explicitly point Poetry to the virtual
environment.

[1] https://github.com/readthedocs/readthedocs.org/pull/11152

Change-Id: I58e49ba6f6d122e70bbcf1dbb10220881a09faf3
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
2024-08-01 15:48:44 +00:00

31 lines
685 B
YAML

# Copyright (c) 2023-2024, Arm Limited. All rights reserved
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Configuration file for the readthedocs deploy
# Available at https://trustedfirmware-a.readthedocs.io/en/latest/
# readthedocs config version
version: 2
build:
os: ubuntu-22.04 # Ubuntu Jammy LTS
tools:
python: "3.10"
apt_packages:
- plantuml
- librsvg2-bin
jobs:
post_create_environment:
- pip install poetry=="1.3.2"
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
sphinx:
configuration: docs/conf.py
# Auxiliary formats to export to (in addition to the default HTML output).
formats:
- pdf