Maintenance: restore Sphinx documentation seach functionality #1396
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
This search-related JS file was added in Sphinx v3.4.0
This style of index loading was added in Sphinx v2.0.0
This follows adjustments made for release v3.4.0 of Sphinx
This search-related JS file was added in Sphinx v5.2.0
This is required for compatibility with Sphinx v7.2.0
After a search, the Sphinx client-side JS can retrieve a snippet of text to display for each result, by making a network request for each item.
|
Note: due to a5dad4c, these changes require a rebuild of the documentation with Sphinx >= 7.2.0 - if an earlier version is preferable, let me know and I can unpick that (and any other relevant commits). |
|
Hi @jayaddison, this looks great, thank you for the PR! |
|
@dbogdanov you're welcome - could you let me know once the documentation is rebuilt, to confirm the fix? (I did test it locally from file, but would like to make sure) |
No need: it looks like that's rebuilt and working again already 👍 |
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.
These changes should restore Sphinx search functionality to the Essentia documentation website.
Roughly speaking: the custom
search.htmltemplate inessentia.githas drifted from the JavaScript files and interfaces provided during a Sphinx HTML documentation build.Additionally, the
sphinxprettysearchresultsextension is removed; it was a workaround for a bug that caused unclearly-formatted search results that was fixed in v2.0.0 of Sphinx.No server-side changes are required with this change.
Resolves #1198.