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.
The sphinxcontrib-globalsubs extension is awesome because using it let us speed up our Sphinx build by a factor of two!
For a bit of background, the Sphinx documentation states that you can add global substitutions via the
rst_prolog
orrst_epilog
configuration variables (which contain text that will be prepended or appended to every reStructuredText source file). However, we didn't realize that adding ∼200 substitutions inrst_epilog
would significantly slow down our documentation builds.After finding sphinx-doc/sphinx#2173, I learned about
sphinxcontrib-globalsubs
. After defining the substitutions with this extension instead ofrst_epilog
, I found that our documentation build dropped from ∼415 s to ∼200 s!