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.

Sign up for GitHub

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

Jump to bottom

Use sphinxcontrib-globalsubs to define reST substitutions instead of rst_epilog #2280

Closed
namurphy opened this issue Aug 8, 2023 · 0 comments · Fixed by #2281
Closed

Use sphinxcontrib-globalsubs to define reST substitutions instead of rst_epilog #2280

namurphy opened this issue Aug 8, 2023 · 0 comments · Fixed by #2281
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: high Issues & PRs with significant urgency and importance that should be addressed soon

Comments

@namurphy
Copy link
Member

namurphy commented Aug 8, 2023 •
edited
Loading

As described in #2277, putting reStructuredText substitutions stored in docs/common_links.rst and storing them in rst_epilog is causing huge slowdowns in our documentation builds. As an alternative, we should use sphinxcontrib-globalsubs to define global substitutions instead.

Since we adopted this practice following Astropy, it would be worth working together to implement sphinxcontrib-globalsubs for both packages simultaneously (see also astropy/astropy#15149).

Supersedes #2277.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org priority: high Issues & PRs with significant urgency and importance that should be addressed soon
Projects
None yet
Milestone
No milestone
1 participant
@namurphy