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

Use uv sync & uv run in docs build #5440

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

browniebroke
Copy link
Member

@browniebroke browniebroke commented Oct 7, 2024

Description

The offical RTD guide was written a few months ago and I realised after merging #5438 that we can in fact simplify a bit more.

Also upstreamed these changes to RTD: readthedocs/readthedocs.org#11655

Checklist:

  • I've made sure that tests are updated accordingly (especially if adding or updating a template option)
  • I've updated the documentation or confirm that my change doesn't require any updates

Rationale

Simpler build steps

Copy link
Collaborator

@foarsitter foarsitter left a comment

Choose a reason for hiding this comment

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

This was the flow I expected in the first place but didn't know how to install the optional dependencies and the existence of --extras.

I would expect the --no-dev and --frozen parameters here. Dev requirements are not required and the lock file should not change.

@browniebroke
Copy link
Member Author

I would expect the --no-dev and --frozen parameters here

Good point! Fixed

@foarsitter
Copy link
Collaborator

Forgot that we don't have dev dependencies xD

Will add some soon ;)

@foarsitter foarsitter merged commit 214e5f5 into cookiecutter:master Oct 8, 2024
13 checks passed
@browniebroke browniebroke deleted the docs-uv-sync branch October 8, 2024 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants