xref: /arm-trusted-firmware/.readthedocs.yaml (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu# Copyright (c) 2023, Arm Limited. All rights reserved
2*91f16700Schasinglulu#
3*91f16700Schasinglulu# SPDX-License-Identifier: BSD-3-Clause
4*91f16700Schasinglulu#
5*91f16700Schasinglulu# Configuration file for the readthedocs deploy
6*91f16700Schasinglulu# Available at https://trustedfirmware-a.readthedocs.io/en/latest/
7*91f16700Schasinglulu
8*91f16700Schasinglulu
9*91f16700Schasinglulu# readthedocs config version
10*91f16700Schasingluluversion: 2
11*91f16700Schasinglulu
12*91f16700Schasinglulubuild:
13*91f16700Schasinglulu  os: ubuntu-22.04 # Ubuntu Jammy LTS
14*91f16700Schasinglulu  tools:
15*91f16700Schasinglulu    python: "3.10"
16*91f16700Schasinglulu  apt_packages:
17*91f16700Schasinglulu    - plantuml
18*91f16700Schasinglulu    - librsvg2-bin
19*91f16700Schasinglulu  jobs:
20*91f16700Schasinglulu    post_create_environment:
21*91f16700Schasinglulu      - pip install poetry=="1.3.2"
22*91f16700Schasinglulu      - poetry config virtualenvs.create false
23*91f16700Schasinglulu    post_install:
24*91f16700Schasinglulu      - poetry install --with doc
25*91f16700Schasinglulu
26*91f16700Schasinglulusphinx:
27*91f16700Schasinglulu  configuration: docs/conf.py
28*91f16700Schasinglulu
29*91f16700Schasinglulu# Auxiliary formats to export to (in addition to the default HTML output).
30*91f16700Schasingluluformats:
31*91f16700Schasinglulu  - pdf
32*91f16700Schasinglulu
33