From 8a84776340bf4215d235b7b6dc09cf94aed8c6b3 Mon Sep 17 00:00:00 2001 From: Boyan Karatotev Date: Thu, 16 Feb 2023 11:16:29 +0000 Subject: [PATCH] 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 Change-Id: I1a620b15ab3924244f305056096024fe117c63dd --- .readthedocs.yaml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .readthedocs.yaml 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 + -- 2.39.5