xref: /rk3399_ARM-atf/.readthedocs.yaml (revision 4f02a740f5844c8019707cb5ea58079749dc3862)
1# Copyright (c) 2023-2025, Arm Limited. All rights reserved
2#
3# SPDX-License-Identifier: BSD-3-Clause
4#
5# Configuration file for the readthedocs deploy
6# Available at https://trustedfirmware-a.readthedocs.io/en/latest/
7
8
9# readthedocs config version
10version: 2
11
12submodules:
13  include: all
14  recursive: true
15
16build:
17  os: ubuntu-22.04 # Ubuntu Jammy LTS
18  tools:
19    python: "3.10"
20  apt_packages:
21    - plantuml
22    - librsvg2-bin
23  jobs:
24    post_create_environment:
25      - pip install poetry=="1.3.2"
26    post_install:
27      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --no-root --with docs
28
29sphinx:
30  configuration: docs/conf.py
31
32# Auxiliary formats to export to (in addition to the default HTML output).
33formats:
34  - pdf
35