Repository navigation
Keep Sphinx doctrees out of published HTML - #27
Merged
Merged
Conversation
Otherwise changes in the binary .doctree/* files will be deployed every day. Keeping these out of the source tree makes the deployment job only deploy if things have actually changed.
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for the change separating Sphinx’s doctree cache from the published HTML output.
No open issues 🎉
What changed in this PR
Moves Sphinx’s doctree cache outside the published HTML directory so binary cache changes do not trigger unnecessary documentation deployments.
Changes:
- Sets a separate, per-distribution doctree directory using Sphinx’s
-doption. - Keeps the existing HTML output locations unchanged.
| File | Description |
|---|---|
scripts/build_docs.sh |
Stores doctrees in _build/doctrees/${distro}, outside the published HTML tree. |
Review effort: Balanced
urrsk
approved these changes
Nov 4, 2026
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
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.
Otherwise changes in the binary .doctree/* files will be deployed every day. Keeping these out of the source tree makes the deployment job only deploy if things have actually changed.