sphinx_highlight.js: remove ?highlight= query param handling
#13921
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
* Do not use `?highlight=` query param as a fallback for search
highlighting. All major browsers support `#:~:text=` natively now, and
Sphinx does not link from search results with `?highlight=` URLs, it
only uses `localStorage`.
* Simplify `document.querySelectorAll("div.body")[0]` to
`document.querySelector("div.body")`
* Simplify `document.querySelector("body")` with `document.body`
* Replace `setTimeout` with `requestAnimationFrame`
haampie
changed the title
?highlight= query param handling
haampie
added a commit
to spack/spack
that referenced
this pull request
Oct 7, 2025
Use Sphinx 8.2.3 with this patch: sphinx-doc/sphinx#13921, so that it's easier to link particular paragraphs in the text using Text Fragments.
haampie
added a commit
to spack/spack
that referenced
this pull request
Oct 7, 2025
Use Sphinx 8.2.3 with this patch: sphinx-doc/sphinx#13921, so that it's easier to link particular paragraphs in the text using Text Fragments. Signed-off-by: Harmen Stoppels <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #13916
Alternative to #13918
?highlight=query param as a (manual) fallback for search highlighting.While at it:
document.querySelectorAll("div.body")[0]todocument.querySelector("div.body")document.querySelector("body")withdocument.bodysetTimeoutwithrequestAnimationFramePurpose
This PR removes the
?highlight=related code, for two reasons:?highlight=links internally.#:~:text=...is a decent replacement for?highlight=...for adding highlighting manually.window.history.replaceStateunconditionally. This has an unpleasant side effect: it removes#:~:text=...fragments from the URL, making it hard to purposefully share URLs that include highlighted text.References
<url>?highlight=search-termtolocalStorage.setItem("sphinx_highlight_terms", "search-term")to support highlighting of search terms on a page: Move to localStorage for search highlighting #10854?highlight=...URLs were still supported, cause you could add that manually.?highlight=...was to always remove?highlight=from the URL.sphinx_highlight.jsremoves text fragment from URL #13916window.history.replaceStateunconditionally #13918