Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinxcontrib-globalsubs #69

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

namurphy
Copy link

@namurphy namurphy commented Aug 9, 2023

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 or rst_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 in rst_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 of rst_epilog, I found that our documentation build dropped from ∼415 s to ∼200 s!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant