]> git.baikalelectronics.ru Git - arm-tf.git/commitdiff
fix(docs): add readthedocs configuration file
authorBoyan Karatotev <boyan.karatotev@arm.com>
Thu, 16 Feb 2023 11:16:29 +0000 (11:16 +0000)
committerBoyan Karatotev <boyan.karatotev@arm.com>
Thu, 16 Feb 2023 13:57:05 +0000 (13:57 +0000)
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

.readthedocs.yaml [new file with mode: 0644]

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..af3fba0
--- /dev/null
@@ -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
+