aboutsummaryrefslogtreecommitdiff
path: root/.readthedocs.yml
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2023-12-21 17:42:00 +0000
committerAlex Bennée <alex.bennee@linaro.org>2024-01-12 13:23:48 +0000
commitb16a45bc5e0e329a16af8a2e020a6e7044f9afa2 (patch)
tree15bd76696f4c0b355bd63730b22bc524f7f0fa36 /.readthedocs.yml
parent4156325cd3c205ce77b82de2c48127ccacddaf5b (diff)
readthodocs: fully specify a build environment
This is now expected by rtd so I've expanded using their example as 22.04 is one of our supported platforms. I tried to work out if there was an easy way to re-generate a requirements.txt from our pythondeps.toml but in the end went for the easier solution. Cc: <qemu-stable@nongnu.org> Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20231221174200.2693694-1-alex.bennee@linaro.org>
Diffstat (limited to '.readthedocs.yml')
-rw-r--r--.readthedocs.yml19
1 files changed, 12 insertions, 7 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 7fb7b8dd61..0b262469ce 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -5,16 +5,21 @@
# Required
version: 2
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.11"
+
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+ install:
+ - requirements: docs/requirements.txt
+
# We want all the document formats
formats: all
-
-# For consistency, we require that QEMU's Sphinx extensions
-# run with at least the same minimum version of Python that
-# we require for other Python in our codebase (our conf.py
-# enforces this, and some code needs it.)
-python:
- version: 3.6