Skip to content

Commit b16a45b

Browse files
committed
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: <[email protected]> Signed-off-by: Alex Bennée <[email protected]> Message-Id: <[email protected]>
1 parent 4156325 commit b16a45b

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

.readthedocs.yml

+12-7
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,21 @@
55
# Required
66
version: 2
77

8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
814
# Build documentation in the docs/ directory with Sphinx
915
sphinx:
1016
configuration: docs/conf.py
1117

18+
# We recommend specifying your dependencies to enable reproducible builds:
19+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- requirements: docs/requirements.txt
23+
1224
# We want all the document formats
1325
formats: all
14-
15-
# For consistency, we require that QEMU's Sphinx extensions
16-
# run with at least the same minimum version of Python that
17-
# we require for other Python in our codebase (our conf.py
18-
# enforces this, and some code needs it.)
19-
python:
20-
version: 3.6

docs/requirements.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx==5.3.0
2+
sphinx_rtd_theme==1.1.1

0 commit comments

Comments
 (0)