Skip to content

Commit 6e072ce

Browse files
author
ocarmi
committed
switch readthedocs to use uv
1 parent d8c54eb commit 6e072ce

File tree

1 file changed

+10
-24
lines changed

1 file changed

+10
-24
lines changed

.readthedocs.yaml

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,21 @@
1-
# .readthedocs.yaml
2-
# Read the Docs configuration file
31
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4-
5-
# Required
62
version: 2
73

8-
# Set the version of Python and other tools you might need
4+
# Set the OS, Python version and other tools you might need
95
build:
10-
os: ubuntu-20.04
6+
os: ubuntu-24.04
117
tools:
12-
python: "3.8"
8+
python: "3.12"
139
jobs:
14-
pre_create_environment:
15-
- asdf plugin add poetry
16-
- asdf install poetry latest
17-
- asdf global poetry latest
18-
- poetry config virtualenvs.create false
1910
post_install:
20-
- poetry install
11+
- pip install uv
12+
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
2113

22-
# Build documentation in the docs/ directory with Sphinx
14+
# Build documentation in the "docs/" directory with Sphinx
2315
sphinx:
2416
configuration: source/conf.py
17+
fail_on_warning: true
2518

26-
# If using Sphinx, optionally build your docs in additional formats such as PDF
27-
# formats:
28-
# - pdf
29-
30-
# Optionally declare the Python requirements required to build your docs
31-
#python:
32-
# version: "3.8"
33-
# install:
34-
# - method: pip
35-
# path: .
19+
# Optionally build your docs in additional formats such as PDF and ePub
20+
formats:
21+
- pdf

0 commit comments

Comments
 (0)