Add tippy_glossary_base_url to fix broken glossary term links in tooltips#33
Open
svekars wants to merge 1 commit intosphinx-extensions2:mainfrom
Open
Add tippy_glossary_base_url to fix broken glossary term links in tooltips#33svekars wants to merge 1 commit intosphinx-extensions2:mainfrom
svekars wants to merge 1 commit intosphinx-extensions2:mainfrom
Conversation
AlannaBurke
approved these changes
Dec 16, 2025
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
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.
RE: #32
Problem
When using sphinx-tippy for glossary tooltips, any :term: references within a glossary term definition create broken links. This happens because the tooltip content uses relative URLs (e.g., #term-Custom-Operation) which resolve relative to the current page instead of the glossary page.
Example:
When hovering over "Custom Operation" on test-page.html, clicking "Compound Operation" in the tooltip navigates to test-page.html#term-Compound-Operation (broken) instead of glossary.html#term-Compound-Operation (correct).
Solution
This PR adds a new configuration option tippy_glossary_base_url that allows users to specify the base URL for glossary term links within tooltips.
Usage:
When configured, all #term-* anchor links inside tooltip content are rewritten to include the glossary base URL (e.g., #term-Something → glossary.html#term-Something).
Testing