Fix search in dirhtml output #7192
Merged
Conversation
This file contains 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
tk0miya
reviewed
Feb 22, 2020
| @@ -63,6 +63,9 @@ var Search = { | |||
| htmlElement.innerHTML = htmlString; | |||
| $(htmlElement).find('.headerlink').remove(); | |||
| docContent = $(htmlElement).find('[role=main]')[0]; | |||
| if(docContent === undefined) { | |||
| return ""; | |||
There was a problem hiding this comment.
It might be helpful if there are debug message in JS console.
There was a problem hiding this comment.
I posted it as an another PR: #7194
|
I confirmed this works fine on my local. |
|
Merged. Thank you for your contribution! |
|
Note that a side effect of this change isn't just that the AJAX requests become absolute, but also that the links themselves become absolute links, including for non-dirhtml builders. Was this intended? |
|
It wasn't necessarily indented that links become absolute. However, the links were being incorrectly generated and were producing all 404s (in dirhtml mode). So the intention was to generate the correct URLs. Is this change causing breakage? |
|
I think so. scikit-image/scikit-image#4616 |
This was referenced Apr 8, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: The built-in JavaScript search exhibits a rather major bug in that it seems to completely break when the output is generated in
dirhtmlmode, OR if a custom theme is missing arole="main"HTML element. This change fixes the search to work correctly in both cases.Feature or Bugfix
Detail
When built in
dirhtml, URLs such asdocs/test.htmlnow becomedocs/test/. However, in many cases the search was performing incorrect ajax queries such asdocs/test/index/anddocs/test/.html. My change looks for the correct URL when making ajax calls in the search.These invalid URLs of course trigger 404s which in turn exposes another bug when trying to process the response HTML and look for a
[role='main']element. This could also have been causing issues with custom themes that do not implement an element withrole=main. My change also handles that case: if that element does not exist, an empty string instead is returned.Relates
There are a couple related issues, which are marked as "closed", but the issue still persists on sphinx 2.4.x. See #6244 , #6257 , #6387
Please provide feedback on if this should be merged into a different branch, or if my Pull Request is missing anything.