-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
More concise uv example with docs #12064
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
base: main
Are you sure you want to change the base?
Conversation
This provides a more succinct uv example using `uv sync`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! This looks like a good improvement over my PR (which I'll close).
Projects managed with `uv <https://github.com/astral-sh/uv/>`__, can install `uv` with asdf, | ||
and then rely on it to set up the environment and install the python project and its dependencies | ||
where readthedocs' own build steps expect it by setting the ``UV_PROJECT_ENVIRONMENT`` variable, | ||
usually reducing the time taken to install compared to pip. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is correct, but I think it would be valuable to break up into a few smaller sentences.
Co-authored-by: Manuel Kaufmann <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to merge with a small fix to the first paragraph as noted.
As a follow up to #11946 (updating the uv example to rely on uv's project management capabilities) , I added here a few paragraphs on what the new
uv
example achieves.I hope that makes it acceptable for integration @ericholscher .
@lengau , it would be appreciated if you could review, that this matches your expectation as well.
Thank you
📚 Documentation previews 📚
docs
): https://docs--12064.org.readthedocs.build/12064/dev
): https://dev--12064.org.readthedocs.build/12064/