Skip to content

Commit 353fbb5

Browse files
committed
use uv for building the docs on readthedocs.org
1 parent 09bc821 commit 353fbb5

File tree

1 file changed

+9
-35
lines changed

1 file changed

+9
-35
lines changed

.readthedocs.yaml

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,24 @@
11
# Read the Docs configuration file for Sphinx projects
2-
32
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
43

5-
64
# Required
75

86
version: 2
97

10-
118
# Set the OS, Python version and other tools you might need
129

1310
build:
1411

1512
os: ubuntu-24.04
16-
13+
1714
tools:
18-
19-
python: "3.12"
20-
21-
# You can also specify other tool versions:
22-
23-
# nodejs: "20"
24-
25-
# rust: "1.70"
26-
27-
# golang: "1.20"
28-
15+
16+
python: 3.12
17+
18+
commands:
19+
20+
- pip install uv
21+
- uv run python -m sphinx docs $READTHEDOCS_OUTPUT/html -b html -W
2922

3023
# Build documentation in the "docs/" directory with Sphinx
3124

@@ -34,31 +27,12 @@ sphinx:
3427
configuration: docs/source/conf.py
3528

3629
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
37-
3830
# builder: "dirhtml"
39-
4031
# Fail on all warnings to avoid broken references
41-
4232
# fail_on_warning: true
4333

4434

4535
# Optionally build your docs in additional formats such as PDF and ePub
46-
4736
# formats:
48-
4937
# - pdf
50-
51-
# - epub
52-
53-
54-
# Optional but recommended, declare the Python requirements required
55-
56-
# to build your documentation
57-
58-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
59-
60-
# python:
61-
62-
# install:
63-
64-
# - requirements: docs/requirements.txt
38+
# - epub

0 commit comments

Comments
 (0)