Browse Source

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
pull/1994/head
Boyan Karatotev 2 years ago
parent
commit
8a84776340
  1. 25
      .readthedocs.yaml

25
.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
Loading…
Cancel
Save