Skip to content

Commit

Permalink
Use uv lockfile in readthedocs build (#6685)
Browse files Browse the repository at this point in the history
Now that we have a bit of good experience with uv lockfile, it would be nice to use it in more places to make various CI jobs more stable. Here I am using it for the RTD docs build. We've already been using uv there so that change is relatively straightforward.

Coincidentaly, ReadTheDocs made some updates to make the configuration with uv nicer, just a couple of days ago see readthedocs/readthedocs.org#11289 (comment) for details.

This also updates the uv version in RTD config.
  • Loading branch information
danielhollas authored Jan 11, 2025
1 parent 8440416 commit 15b5caf
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,17 @@ build:
jobs:
# Use uv to speed up the build
# https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-uv
post_create_environment:
pre_create_environment:
- asdf plugin add uv
- asdf install uv 0.2.9
- asdf global uv 0.2.9
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install .[docs,tests,rest,atomic_tools]

# Let the build fail if there are any warnings
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true
- asdf install uv 0.5.17
- asdf global uv 0.5.17
create_environment:
- uv venv
install:
- uv sync --extra docs --extra tests --extra rest --extra atomic_tools
build:
html:
- uv run sphinx-build -T -W --keep-going -b html -d _build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html

search:
ranking:
Expand Down

0 comments on commit 15b5caf

Please sign in to comment.