diff options
| author | Boyan Karatotev <boyan.karatotev@arm.com> | 2023-02-16 11:16:29 +0000 |
|---|---|---|
| committer | Boyan Karatotev <boyan.karatotev@arm.com> | 2023-02-16 13:57:05 +0000 |
| commit | 8a84776340bf4215d235b7b6dc09cf94aed8c6b3 (patch) | |
| tree | db42f985fc8a00ee684c521789c9a360b1aeea0a /.readthedocs.yaml | |
| parent | 5a77fd3ba15f7931bae0783b3a7389e72f99bcf5 (diff) | |
| download | arm-trusted-firmware-8a84776340bf4215d235b7b6dc09cf94aed8c6b3.tar.gz | |
fix(docs): add readthedocs configuration file
Readthedocs uses weird defaults and the web interface gives limited
configuration options. Add the config file to allow them to be changed.
Bump build os image to Ubuntu 22.04 to be in line with the CI.
Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
Change-Id: I1a620b15ab3924244f305056096024fe117c63dd
Diffstat (limited to '.readthedocs.yaml')
| -rw-r--r-- | .readthedocs.yaml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..af3fba058 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# Copyright (c) 2023, 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 + +build: + os: ubuntu-22.04 # Ubuntu Jammy LTS + +python: + install: + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/conf.py + +# Auxiliary formats to export to (in addition to the default HTML output). +formats: + - pdf + |