Skip to content

Commit 6b9ec1e

Browse files
committed
doc: fix broken RTD build
The project was created some years ago and RTD defaults to some ancient Sphinx version that recently broke due to a docutils update. Use a configuration file and pin the required packages to make the build reproducible.
1 parent 09df17d commit 6b9ec1e

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
3+
sphinx:
4+
configuration: doc/conf.py
5+
6+
python:
7+
install:
8+
- requirements: doc/requirements.txt
9+
10+
build:
11+
tools:
12+
python: "3.9"

doc/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx==4.2.0
2+
sphinx_rtd_theme==1.0.0
3+
readthedocs-sphinx-search==0.1.1

0 commit comments

Comments
 (0)