Documentation search improvements #3378
Open
+39
−0
Conversation
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
A5rocks
commented
Jan 15, 2026
| <ul> | ||
| {%- for subentryname, subentrylinks in subitems %} | ||
| {% set sname = subentrylinks[0][1].rsplit('#', 1)[1] if subentrylinks else '' %} | ||
| <li>{{ indexentries(sname if sname and '-' not in sname else subentryname, subentrylinks) }}</li> |
Contributor
Author
There was a problem hiding this comment.
This is very hacky, but I know better than to dive into Sphinx internals :-)
Is there a way we can customize what autofunction etc puts in the index? If so that would be significantly more elegant...
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.
As discussed in Gitter, the documentation search results that RTD provides kinda suck. I believe it's just a full-text search, so we have to include any fully-qualified names for the search to accept them (try searching
Event.is_settoday!).This PR is to try that, though I haven't finished yet because I want to see what the documentation preview will look like