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

Update uv in RTD config #660

Merged
merged 8 commits into from
Jan 13, 2025
Merged

Update uv in RTD config #660

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
89ccb55
Update uv in RTD config
danielhollas Jan 8, 2025
83a7dd7
Use sphinx-build
danielhollas Jan 8, 2025
57ec1e4
Try this
danielhollas Jan 8, 2025
3796ba5
Use --prefix option
danielhollas Jan 8, 2025
04ce532
Don't use uv cache
danielhollas Jan 8, 2025
f01298d
RTD: Add configuration file explicitly
danielhollas Jan 11, 2025
34d2fd6
Bump to 0.5.17
danielhollas Jan 11, 2025
80ebc2a
Merge branch 'master' into rtd-uv-update
danielhollas Jan 13, 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: 14 additions & 7 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,17 @@ build:
os: ubuntu-22.04
tools:
python: '3.11'
commands:
- asdf plugin add uv
- asdf install uv 0.1.44
- asdf global uv 0.1.44
- uv venv
- uv pip install .[docs]
- .venv/bin/python -m sphinx -W --keep-going -d _build/doctrees -D language=en -b html docs/source $READTHEDOCS_OUTPUT/html
jobs:
pre_create_environment:
- asdf plugin add uv
- asdf install uv 0.5.17
- asdf global uv 0.5.17
create_environment:
- uv venv $READTHEDOCS_VIRTUALENV_PATH
install:
Copy link
Contributor Author

@danielhollas danielhollas Jan 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unlike with uv sync which we use in aiida-core, here we can manually specify the target virtual environment with uv pip install. This in turn let's us use the sphinx section below instead of specifying the build command manually.

- uv pip install .[docs] --no-cache --prefix $READTHEDOCS_VIRTUALENV_PATH

sphinx:
builder: html
fail_on_warning: true
configuration: docs/source/conf.py
Loading