Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RTD config to use 'uv' for faster builds #1101

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ build:
os: "ubuntu-22.04"
tools:
python: "3.11"
jobs:
pre_build:
- bash ./scripts/rtd-pre-sphinx-build.sh

python:
install:
- method: pip
path: .
- requirements: "requirements/py3.11/docs.txt"
# use 'uv pip install' to apply build customization in a pip-compatible way
# see: https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-uv
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv venv
- uv pip install . -r "requirements/py3.11/docs.txt"
- bash ./scripts/rtd-pre-sphinx-build.sh
- uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
2 changes: 1 addition & 1 deletion scripts/rtd-pre-sphinx-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ if [ -z "$(find changelog.d -name '*.rst')" ]; then
exit 0
fi

scriv collect --keep --version "$VERSION" -v DEBUG
uv run scriv collect --keep --version "$VERSION" -v DEBUG