Fix navbar rendering for special pages in toctree#2447
Open
medmunds wants to merge 1 commit into
Open
Conversation
Support Sphinx virtual docnames "genindex", "modindex" and "search" in generate_header_nav_html(). Fixes pydata#2446.
medmunds
commented
Jul 15, 2026
Comment on lines
+166
to
+171
| elif page == "genindex": | ||
| title = _("Index") | ||
| elif page == "modindex": | ||
| title = _("Python Module Index") | ||
| elif page == "search": | ||
| title = _("Search") |
Author
There was a problem hiding this comment.
This assumes any translations for these strings will be valid html. (That is, the translated strings don't need html escaping. The translation for the "More" menu label makes the same assumption—see _(dropdown_text) on line 315.)
Comment on lines
+173
to
+175
| raise RuntimeError( | ||
| f"Could not find title for toctree entry: {page!r}" | ||
| ) |
Author
There was a problem hiding this comment.
The AI wanted to set title = page here to fall back to the docname. I wasn't sure how that might occur, and since the original code raised a KeyError for an unknown page we compromised on this.
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
1 participant
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.
Support Sphinx virtual docnames "genindex", "modindex" and "search" in
generate_header_nav_html(). Fixes #2446.AI disclosure: PyCharm AI Assistant (chat mode, GPT-5.5 Medium) assisted with identifying the problem and refining the solution and the test case.