Files
arm-trusted-firmware/.readthedocs.yaml
T
Harrison Mutai efb21ddae3 fix(docs): ensure all submodules are cloned
`TLC`, which is part of `LibTL`, is consumed via a Git submodule. Its
presence is required when running `poetry install`. Ensure that all
submodules are initialized and updated by explicitly configuring
RTD to fetch submodules recursively prior to installation.

Change-Id: I49e2911473240cb6cbd72234d3a186d077dc307f
Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
2025-09-24 10:52:56 +00:00

35 lines
740 B
YAML

# Copyright (c) 2023-2025, 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
submodules:
include: all
recursive: true
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 --no-root --with docs
sphinx:
configuration: docs/conf.py
# Auxiliary formats to export to (in addition to the default HTML output).
formats:
- pdf