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.

Sign up for GitHub

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

Use uv lockfile in readthedocs build #6685

Merged
merged 4 commits into from
Jan 11, 2025
Merged

Use uv lockfile in readthedocs build #6685

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bad179
Simplify uv configuration in .reatthedocs.yml
danielhollas Jan 8, 2025
677dc31
Add build step, use lockfile
danielhollas Jan 8, 2025
87e774d
Merge branch 'main' into rtd-uv-update
danielhollas Jan 11, 2025
3877e5d
Bump to 0.5.17 to get performance improvements
danielhollas Jan 11, 2025
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
21 changes: 10 additions & 11 deletions .readthedocs.yml
View file
Open in desktop
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
Loading