Skip to content

Commit 3dc25cf

Browse files
authored
Update Read the Docs configuration for Sphinx build
The error is coming from Read the Docs now requiring a build.os (and build.tools.python) section in v2 configs. Add a build: block (and fix the indentation under python.install) and the config should validate.
1 parent 073c5ba commit 3dc25cf

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

.readthedocs.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
# .readthedocs.yml
2-
# Read the Docs configuration file
3-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4-
5-
# Required
61
version: 2
72

8-
# Build documentation in the docs/ directory with Sphinx
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.11"
7+
98
sphinx:
109
configuration: docs/sphinx/source/conf.py
1110

12-
# Just generate htmlzip version, as pdf failing due to inclusion of svg files (in badges)
1311
formats:
1412
- htmlzip
1513

1614
python:
1715
install:
18-
- requirements: docs/sphinx/requirements.txt
16+
- requirements: docs/sphinx/requirements.txt
1917

2018
submodules:
2119
exclude: all

0 commit comments

Comments
 (0)