Skip to content

Commit a565dc5

Browse files
committed
ci: readthedocs
- Use "version: 2" config so we can use newer python. - Fail on sphinx warnings.
1 parent f39f62b commit a565dc5

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

.readthedocs.yml

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1+
# readthedocs config file for Sphinx projects
2+
# https://docs.readthedocs.io/en/stable/config-file/v2.html
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
18
build:
2-
image: latest
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
# Fail on all warnings.
17+
fail_on_warning: true
318

419
python:
5-
version: 3.8
6-
setup_py_install: true
20+
install:
21+
- requirements: docs/requirements.txt
22+
- method: pip
23+
path: .

0 commit comments

Comments
 (0)