[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 21/43] readthodocs: fully specify a build environment
From: |
Alex Bennée |
Subject: |
[PATCH v2 21/43] readthodocs: fully specify a build environment |
Date: |
Wed, 3 Jan 2024 17:33:27 +0000 |
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>
---
docs/requirements.txt | 2 ++
.readthedocs.yml | 19 ++++++++++++-------
2 files changed, 14 insertions(+), 7 deletions(-)
create mode 100644 docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000000..691e5218ec7
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1
diff --git a/.readthedocs.yml b/.readthedocs.yml
index 7fb7b8dd61a..0b262469ce6 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
--
2.39.2
- [PATCH v2 19/43] tests/fp: Bump fp-test-mulAdd test timeout to 3 minutes, (continued)
- [PATCH v2 19/43] tests/fp: Bump fp-test-mulAdd test timeout to 3 minutes, Alex Bennée, 2024/01/03
- [PATCH v2 18/43] tests/unit: Bump test-crypto-block test timeout to 5 minutes, Alex Bennée, 2024/01/03
- [PATCH v2 37/43] gdbstub: expose api to find registers, Alex Bennée, 2024/01/03
- [PATCH v2 41/43] contrib/plugins: optimise the register value tracking, Alex Bennée, 2024/01/03
- [PATCH v2 30/43] gdbstub: Use GDBFeature for GDBRegisterState, Alex Bennée, 2024/01/03
- [PATCH v2 24/43] target/riscv: Move misa_mxl_max to class, Alex Bennée, 2024/01/03
- [PATCH v2 29/43] gdbstub: Use GDBFeature for gdb_register_coprocessor, Alex Bennée, 2024/01/03
- [PATCH v2 26/43] target/arm: Use GDBFeature for dynamic XML, Alex Bennée, 2024/01/03
- [PATCH v2 21/43] readthodocs: fully specify a build environment,
Alex Bennée <=
- [PATCH v2 38/43] plugins: add an API to read registers, Alex Bennée, 2024/01/03
- Re: [PATCH v2 38/43] plugins: add an API to read registers, Pierrick Bouvier, 2024/01/09
- Re: [PATCH v2 38/43] plugins: add an API to read registers, Pierrick Bouvier, 2024/01/11
- [PATCH v2 40/43] contrib/plugins: extend execlog to track register changes, Alex Bennée, 2024/01/03