Skip to content

Documentation search improvements#3378

Open
A5rocks wants to merge 5 commits intopython-trio:mainfrom
A5rocks:docs-searching
Open

Documentation search improvements#3378
A5rocks wants to merge 5 commits intopython-trio:mainfrom
A5rocks:docs-searching

Conversation

@A5rocks
Copy link
Contributor

@A5rocks A5rocks commented Jan 15, 2026

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_set today!).

This PR is to try that, though I haven't finished yet because I want to see what the documentation preview will look like

<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>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

@A5rocks A5rocks marked this pull request as ready for review January 15, 2026 06:31
@codecov
Copy link

codecov bot commented Feb 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00000%. Comparing base (0124394) to head (cf7ab92).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@               Coverage Diff               @@
##                 main        #3378   +/-   ##
===============================================
  Coverage   100.00000%   100.00000%           
===============================================
  Files             128          128           
  Lines           19414        19414           
  Branches         1318         1318           
===============================================
  Hits            19414        19414           

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant