Fix #8419: html search: Do not load language_data.js in non-search pages #8445
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
…-search pages The ``language_data.js`` is only used on search page. But it is always loaded meaninglessly. This fixes not to load it on all non-search pages.
zzzeek
added a commit
to sqlalchemyorg/zzzeeksphinx
that referenced
this pull request
Jan 5, 2021
Sphinx removed a necessary js file in sphinx-doc/sphinx#8445 . add it to our search template.
|
hey there. Wondering what a more long term solution would be for maintainers of custom themes to not constantly get hit with these after the fact. You can see here three custom themes have already been hit. Looking in Sphinx changelog I can see this issue is buried in a long list of other issues under "bugs fixed" with a terse message "html search: Do not load https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES#L183 there appears to be a more prominent section called "Incompatible changes" with just one API change in it. Is it possible that fully breaking changes like these appear under "incompatible changes" and perhaps include some more detail what they mean ? thanks for reading. |
2 tasks
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Jan 11, 2021
Sphinx stopped loading language_data.js globally in 3.4. This file now has to be loaded explicitly on the search page. See - sphinx-doc/sphinx#8445 - readthedocs/sphinx_rtd_theme#1021
alexzorin
added a commit
to alexzorin/sphinx_rtd_theme
that referenced
this pull request
May 12, 2021
Due to sphinx-doc/sphinx#8445 and the fact that we are not keeping this theme fork up to date, it's necessary to explicitly load this script on the search.html page.
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.
Feature or Bugfix
Purpose
language_data.jsis only used on search page. But it is alwaysloaded meaninglessly. This fixes not to load it on all non-search pages.