close
Skip to content

Speed up doc build by reworking links - #14167

Merged
larsoner merged 1 commit into
mne-tools:mainfrom
larsoner:rst
Aug 21, 2026
Merged

Speed up doc build by reworking links#14167
larsoner merged 1 commit into
mne-tools:mainfrom
larsoner:rst

Conversation

@larsoner

Copy link
Copy Markdown
Member

Until sphinx-doc/sphinx#14612 lands, this will speed up our doc build by not including names.inc in every doc. This PR:

  1. Removes links.inc from rst_prolog (better explicit than implicit: include in the few docs that need it)
  2. Removes dead links from links.inc
  3. Inlines single-use links from links.inc (we should include links there only if they're used multiple places)
  4. Moves some multi-use links from repeated defs to links.inc
  5. Adds a checker for the above (e.g., links in links.inc if and only if referenced twice, none dead, etc.)

Changes drafted with Claude Fable 5 and reviewed and iterated on by me.

@larsoner
larsoner merged commit f77431a into mne-tools:main Aug 21, 2026
34 of 35 checks passed
@larsoner
larsoner deleted the rst branch August 21, 2026 15:12
@larsoner

Copy link
Copy Markdown
Member Author

Going to get this one in since it speeds up CIs and is a refactor that prevents future regressions, but happy to open a follow-up if people have comments!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant