Skip to content

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

coroa
Copy link

@coroa coroa commented Mar 21, 2025

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 📚

@coroa coroa requested a review from a team as a code owner March 21, 2025 16:10
@coroa coroa requested a review from agjohnson March 21, 2025 16:10
Copy link

@lengau lengau left a 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).

Comment on lines +453 to +456
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.
Copy link

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.

@lengau lengau mentioned this pull request Mar 21, 2025
@ericholscher ericholscher self-requested a review March 21, 2025 20:23
Copy link
Member

@ericholscher ericholscher left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants