docs: add a "glossary" section to the guide, automatically link to it#5933
Merged
davidhewitt merged 5 commits intoPyO3:mainfrom Apr 2, 2026
Merged
docs: add a "glossary" section to the guide, automatically link to it#5933davidhewitt merged 5 commits intoPyO3:mainfrom
davidhewitt merged 5 commits intoPyO3:mainfrom
Conversation
LilyFirefly
approved these changes
Apr 1, 2026
Contributor
LilyFirefly
left a comment
LilyFirefly
left a comment
There was a problem hiding this comment.
The docs fixes look great! I have not reviewed the glossary linker closely.
Member
Author
|
The only remaining link check error I think is I'll proceed to merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a glossary page to the guide, as an attempt to create common definitions of terms which occur frequently in the guide (and are relatively critical to user understanding).
I added a
glossary_linker.pymdbook preprocessor which automatically links the first reference of each term on each page to the glossary (including some specially curated terms found in external glossaries such as the Python docs).Full disclosure:
glossary_linker.pywas vibe-coded by Claude with some manual adjustment and review by me. There was no way I would get the regular expressions for the "skip" patterns correct without a lot of trial-and-error 😂