xref: /rk3399_ARM-atf/.readthedocs.yaml (revision 4f02a740f5844c8019707cb5ea58079749dc3862)
1ed0c801fSChris Kay# Copyright (c) 2023-2025, Arm Limited. All rights reserved
28a847763SBoyan Karatotev#
38a847763SBoyan Karatotev# SPDX-License-Identifier: BSD-3-Clause
48a847763SBoyan Karatotev#
58a847763SBoyan Karatotev# Configuration file for the readthedocs deploy
68a847763SBoyan Karatotev# Available at https://trustedfirmware-a.readthedocs.io/en/latest/
78a847763SBoyan Karatotev
88a847763SBoyan Karatotev
98a847763SBoyan Karatotev# readthedocs config version
108a847763SBoyan Karatotevversion: 2
118a847763SBoyan Karatotev
12*efb21ddaSHarrison Mutaisubmodules:
13*efb21ddaSHarrison Mutai  include: all
14*efb21ddaSHarrison Mutai  recursive: true
15*efb21ddaSHarrison Mutai
168a847763SBoyan Karatotevbuild:
178a847763SBoyan Karatotev  os: ubuntu-22.04 # Ubuntu Jammy LTS
184052d958SBoyan Karatotev  tools:
193aa919ebSBoyan Karatotev    python: "3.10"
2065982a94SBoyan Karatotev  apt_packages:
2165982a94SBoyan Karatotev    - plantuml
22c3654760SHarrison Mutai    - librsvg2-bin
23793f72c0SHarrison Mutai  jobs:
24793f72c0SHarrison Mutai    post_create_environment:
255f0f3bf4SHarrison Mutai      - pip install poetry=="1.3.2"
26793f72c0SHarrison Mutai    post_install:
27ed0c801fSChris Kay      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --no-root --with docs
288a847763SBoyan Karatotev
298a847763SBoyan Karatotevsphinx:
308a847763SBoyan Karatotev  configuration: docs/conf.py
31d48a6462SManish V Badarkhe
32d48a6462SManish V Badarkhe# Auxiliary formats to export to (in addition to the default HTML output).
33d48a6462SManish V Badarkheformats:
34d48a6462SManish V Badarkhe  - pdf
35