xref: /rk3399_ARM-atf/.readthedocs.yaml (revision ed0c801fc69f55103c597dcc29cadf4c7cb7d575)
1*ed0c801fSChris 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
128a847763SBoyan Karatotevbuild:
138a847763SBoyan Karatotev  os: ubuntu-22.04 # Ubuntu Jammy LTS
144052d958SBoyan Karatotev  tools:
153aa919ebSBoyan Karatotev    python: "3.10"
1665982a94SBoyan Karatotev  apt_packages:
1765982a94SBoyan Karatotev    - plantuml
18c3654760SHarrison Mutai    - librsvg2-bin
19793f72c0SHarrison Mutai  jobs:
20793f72c0SHarrison Mutai    post_create_environment:
215f0f3bf4SHarrison Mutai      - pip install poetry=="1.3.2"
22793f72c0SHarrison Mutai    post_install:
23*ed0c801fSChris Kay      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --no-root --with docs
248a847763SBoyan Karatotev
258a847763SBoyan Karatotevsphinx:
268a847763SBoyan Karatotev  configuration: docs/conf.py
27d48a6462SManish V Badarkhe
28d48a6462SManish V Badarkhe# Auxiliary formats to export to (in addition to the default HTML output).
29d48a6462SManish V Badarkheformats:
30d48a6462SManish V Badarkhe  - pdf
31