Update RTD config to use 'uv' for faster builds #1101
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1 and
MaxTueckeGlobus
as code owners
Using `build.commands`, we completely override the build process for RTD. Per their documentation (linked in a comment), this is the way to convert a doc build to use `uv`. The install is done using the `uv pip` interface, which has a few advantages: - it can be treated as a plug-in replacement for `pip ...` - it supports `-r` options (so we don't need to change how we're locking dependencies here) - it ensures that we don't see any surprising new semantics from the uv lockfile (which could be hard to troubleshoot locally) Because we're now using `build.commands`, there's no point in keeping `jobs.pre_build` as separate config. Simply inline the relevant command into our overridden process.
Running this before the other commands is incorrect. It requires `scriv`, which therefore requires that doc requirements are installed.
|
I think this PR shows an interesting historical record but is not worth pursuing. One RTD build time before this PR: 1m19s You can see how much I had to munge things to get it to work. I think |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an initial exploration of ways in which we can safely drop
uvinto our existing process without any requisite changes to the local dev experience.RTD is chosen because
Using
build.commands, we completely override the build process for RTD. Per their documentation (linked in a comment), this is the way to convert a doc build to useuv.The install is done using the
uv pipinterface, which has a few advantages:pip ...-roptions (so we don't need to change how we're locking dependencies here)Because we're now using
build.commands, there's no point in keepingjobs.pre_buildas separate config. Simply inline the relevant command into our overridden process.📚 Documentation preview 📚: https://globus-sdk-python--1101.org.readthedocs.build/en/1101/