doc: Add a section for Github Pages incremental build

[SilverRainZ]

Purpose

I created a general tool for enabling Sphinx incremental builds in any CI/CD environment and integrated with the sphinx-notes/pages action. I hope it can be mentioned in Sphinx documentation so more people can speed up the documentation build easily.

The sphinx-notes/pages already have 1800+ users on Github, so I think it's stable enough and worth recommending.

References

• I got idea from [WIP] Add GitLab CI workflow for incremental HTML build #11595, and I will create a section for GitLab in the future PR

[SilverRainZ]

Hi @AA-Turner, can you please review this PR?

[AA-Turner]

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

[SilverRainZ]

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.