Make parallel documentation builds threadsafe #11009
Merged
+251
−98
Conversation
This file contains hidden or 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
for more information, see https://pre-commit.ci
Contributor
Author
|
Hmm collision happened in CI, must've missed one. Will pick this up next week. |
…n/xarray into doc/threadsafe-docs-builds
Closed
Contributor
Author
|
Ok, I think that's all of them. I've run the This is ready for review @max-sixty @dcherian |
dcherian
approved these changes
Jan 2, 2026
The jupyter-execute directive content was using 3-space indentation instead of the standard 4-space indentation, which caused Sphinx warnings and failed the RTD build (fail_on_warning: true). Co-authored-by: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Follow on to #11003
This PR attempts to make multiple concurrent docs builds threadsafe. The main problem is that some jupyter-execute sections create, read and delete files. When run concurrently there can be collisions.
To resolve this I added some hidden cells which ensure files are created in unique tempdirs. This also has the added benefit of not littering your workdir with these files in the case of a docs build failure.
I also enabled parallel builds in
sphinx-llmagain because there should be no more collisions.I've run the build multiple times locally and have not observed a collision so hopefully I got them all.