doc: Add a section for Github Pages incremental build#14097
Open
SilverRainZ wants to merge 1 commit into
Open
Conversation
Carreau
approved these changes
Nov 26, 2025
Contributor
Author
|
Hi @AA-Turner, can you please review this PR? |
Member
|
Thanks for the ping. I'm not really comfortable with suggesting a third-party action; I'd much prefer to (a) have something under @sphinx-doc, or (b) tell users exactly what commands/steps to run. A |
Contributor
Author
|
Thanks for your reponse, I get it. Unfortunately, it is quite complex to prepare an environment to make HTML incremental build work (we need to fix the timestamp of rst source files and the template files of the Sphinx theme). Besides, we also need to restore and save the artifacts (doctrees, env.pickle, and HTML files) from CI's cache service. This might be too much for a deployment document. |
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
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.
Purpose
I created a general tool for enabling Sphinx incremental builds in any CI/CD environment and integrated with the
sphinx-notes/pagesaction. I hope it can be mentioned in Sphinx documentation so more people can speed up the documentation build easily.The
sphinx-notes/pagesalready have 1800+ users on Github, so I think it's stable enough and worth recommending.References