Docs search: Replace jQuery with vanilla JavaScript #106743
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
hugovk
changed the title
hugovk
added
needs backport to 3.11
egeakman
approved these changes
Jul 14, 2023
Contributor
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
GH-106802 is a backport of this pull request to the 3.12 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 16, 2023
* Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let' (cherry picked from commit c02ee45) Co-authored-by: Hugo van Kemenade <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 16, 2023
* Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let' (cherry picked from commit c02ee45) Co-authored-by: Hugo van Kemenade <[email protected]>
|
GH-106803 is a backport of this pull request to the 3.11 branch. |
hugovk
added a commit
that referenced
this pull request
Jul 16, 2023
#106802) Docs search: Replace jQuery with vanilla JavaScript (GH-106743) * Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let' (cherry picked from commit c02ee45) Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk
added a commit
that referenced
this pull request
Jul 16, 2023
#106803) Docs search: Replace jQuery with vanilla JavaScript (GH-106743) * Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let' (cherry picked from commit c02ee45) Co-authored-by: Hugo van Kemenade <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Good
Expected result:
https://docs.python.org/3/search.html?q=asynchronous+generator+iterator&check_keywords=yes&area=default
The glossary item is highlighted:
Bad
Actual result:
https://docs.python.org/3.13/search.html?q=asynchronous+generator+iterator
There's no glossary summary, and there are search.html errors in the console:
Problem
This is because Sphinx 6 removed jQuery:
https://www.sphinx-doc.org/en/master/changes.html#release-6-0-0-released-dec-29-2022 has a couple of options on how to re-add jQuery, but it would be better rewrite https://github.com/python/docsbuild-scripts/blob/main/templates/switchers.js to use vanilla JavaScript.
Fix
Rewrite using vanilla JavaScript.
📚 Documentation preview 📚: https://cpython-previews--106743.org.readthedocs.build/en/106743/search.html?q=asynchronous+generator+iterator