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.

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

More concise uv example #11946

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

More concise uv example #11946

wants to merge 3 commits into from

Conversation

lengau
Copy link

@lengau lengau commented Jan 23, 2025

This provides a more succinct uv example using uv sync. It also has the benefit of not requiring overriding of any build steps.


📚 Documentation previews 📚

This provides a more succinct uv example using `uv sync`
@lengau lengau requested a review from a team as a code owner January 23, 2025 00:50
@lengau lengau requested a review from ericholscher January 23, 2025 00:50
Comment on lines -476 to -479
html:
- uv run sphinx-build -T -b html docs $READTHEDOCS_OUTPUT/html

MkDocs projects could use ``NO_COLOR=1 uv run mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html`` instead.
Copy link
Member

Choose a reason for hiding this comment

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

Seems this is removing the build step completely?

Copy link
Author

Choose a reason for hiding this comment

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

It's no longer overriding the build step because it doesn't need to, since uv is installing things in the regular RTD virtualenv. Here's a screenshot of a real run of this (from canonical/starbase#330):

image

Copy link
Author

Choose a reason for hiding this comment

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

And the full build log: starbase-build-log.txt

@lengau lengau requested a review from ericholscher January 25, 2025 22:40
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.

2 participants