Skip to content

Commit adf7e26

Browse files
committed
Add Read the Docs config
1 parent 13cc4e8 commit adf7e26

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

.readthedocs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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
6+
version: 2
7+
8+
# Don't publish the docs if there are any warnings, as they might be relevant
9+
# https://github.com/readthedocs/readthedocs.org/issues/6837#issuecomment-607229633
10+
sphinx:
11+
configuration: docs/source/conf.py
12+
fail_on_warning: true
13+
14+
# Formats of the documentation to be built
15+
formats:
16+
- htmlzip
17+
- pdf
18+
19+
build:
20+
os: ubuntu-lts-latest
21+
tools:
22+
python: "3.13"
23+
jobs:
24+
install:
25+
- pip install .
26+
- pip install dependency-groups
27+
- pip-install-dependency-groups doc

0 commit comments

Comments
 (0)