DOC Enable sphinx search summary #27797
Merged
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
glemaitre
approved these changes
Nov 17, 2023
There was a problem hiding this comment.
Thanks @lesteve
I think this is more informative and it would have helped @lorentzenchr in his search of benchmarking.
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.
Showing the context of the hint is handy to decide which link is more likely to have the information we want when we use the doc search bar.
This PR:
our current search:
I think it was disabled because for consistency with the custom search code we had previously and maybe out of a concern that it was slow, e.g. #24128 (comment). It does not feel too slow for me in the CircleCI artifacts: https://output.circle-artifacts.com/output/job/b8445a52-e0db-4fb5-99c9-eb974695f950/artifacts/0/doc/search.html?q=ridge
While doing that I noticed that
html_search_show_summary=Truewas not working. This is a change in sphinx 7.2 that was also noticed in sphinx-pydata-theme: pydata/pydata-sphinx-theme#1498 with the fix in pydata/pydata-sphinx-theme#1559The sphinx 7.2 change is here:
sphinx-doc/sphinx@8e730ae#diff-a5066e933cbf65adc46e0d1ab9a0b44e0a53ca64cc95dca7e6aa902aed6bd468R105
This is wonderful by the way, direct commit in
main, no context to understand the reason for the change, no changelog entry, oh well "c'est la vie" as we say 😉Side-comment: maybe we can remove the "Internet Explorer < 9" line, these days I think nobody uses this anymore. Internet Explorer 9 was released in March 2011.