Skip to content

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

Closed

Description

@namurphy

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.

Activity

  1. added
    priority: highIssues & PRs with significant urgency and importance that should be addressed soon
    docsPlasmaPy Docs at http://docs.plasmapy.org
    on Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsPlasmaPy Docs at http://docs.plasmapy.orgpriority: highIssues & PRs with significant urgency and importance that should be addressed soon

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions