-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
jQuery not loaded automatically with sphinxcontrib-jquery 4.0.0 #1452
Comments
A workaround is to add this in your conf.py file. extensions = [
"sphinxcontrib.jquery",
] And there is no need to install the dependency, since the theme already installs it. |
@stsewd that's a clarification of the description content? |
@benjaoming just a workaround for users hitting this problem, feel free to put that in the description! |
@stsewd it was already there, so I was confused if you were writing it differently :) |
oh, missed that! |
With a workaround suggested in readthedocs/sphinx_rtd_theme#1452
To workaround readthedocs/sphinx_rtd_theme#1452
Also just hit this error and #1452 (comment) solved the issue. |
To workaround readthedocs/sphinx_rtd_theme#1452
Apply Workaround for broken flyout menu. Bug report: readthedocs/readthedocs.org#10242 Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
Apply Workaround for broken flyout menu. Bug report: readthedocs/readthedocs.org#10242 Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
The current theme requires `sphinxcontrib.jquery` to perform search. There is an unresolved bug [1] that results in this extension not loading automatically. 1. readthedocs/sphinx_rtd_theme#1452 git-svn-id: https://svn.blender.org/svnroot/bf-manual/branches/blender-3.5-release/blender_docs@10116 c4de1f47-6596-e411-a384-0024e86c2797
Implement a workaround to get search working again readthedocs/sphinx_rtd_theme#1452 (comment)
This commit fixes search by adding a workaround to the Readthedocs configuration. For the workaround see readthedocs/sphinx_rtd_theme#1452 (comment)
1.2.2 includes PR 1448 which fixes issue 1452 - readthedocs/sphinx_rtd_theme#1448 - readthedocs/sphinx_rtd_theme#1452
This addresses a regression in `sphinx_rtd_theme` that causes `sphinxcontrib.jquery` to be not loaded. Consequently, the search page seems to be hanging; the cause is that `jQuery` is undefined. Adding `sphinxcontrib.jquery` is a suggested workaround at readthedocs/sphinx_rtd_theme#1452. Since I see another problem with search locally and in the PR build on rtd.org, I bump to the latest `Sphinx` and `sphinx_rtd_theme`. This doesn't fix the problem, though. However, rtd.org seems to be fine with these requirements. The problem I have been seeing is a `undefined` sprinkled in the `requestUrl` variable in Sphinx's `searchtools.js` which causes page loads to fail for previewing the search hits. Maybe this problem will disappear in the regular build on rtd.org. Squashed commits: * Fix search on readthedocs.org by bumping sphinx_rtd_theme to 1.2.2 1.2.2 includes PR 1448 which fixes issue 1452 - readthedocs/sphinx_rtd_theme#1448 - readthedocs/sphinx_rtd_theme#1452 * Fixup: remove `html_theme_path` Suggested in readthedocs/sphinx_rtd_theme#1452 (comment) * Fixup 2: or, add 'sphinxcontrib.jquery' to 'extensions' * Fixup 3: bump to latest Sphinx and rtd theme
fixes: #925 Fix for missing jquery in search: readthedocs/sphinx_rtd_theme#1452
This works around cases where Sphinx does not add jQuery automatically on some local setups <readthedocs/sphinx_rtd_theme#1452>.
This works around cases where Sphinx does not add jQuery automatically on some local setups <readthedocs/sphinx_rtd_theme#1452>.
Workaround for readthedocs/sphinx_rtd_theme#1452
Workaround for readthedocs/sphinx_rtd_theme#1452
As per: readthedocs/sphinx_rtd_theme#1452 Signed-off-by: Karol Gugala <[email protected]>
As per: readthedocs/sphinx_rtd_theme#1452 Signed-off-by: Karol Gugala <[email protected]>
This addresses a regression in `sphinx_rtd_theme` that causes `sphinxcontrib.jquery` to be not loaded. Consequently, the search page seems to be hanging; the cause is that `jQuery` is undefined. Adding `sphinxcontrib.jquery` is a suggested workaround at readthedocs/sphinx_rtd_theme#1452. Since I see another problem with search locally and in the PR build on rtd.org, I bump to the latest `Sphinx` and `sphinx_rtd_theme`. This doesn't fix the problem, though. However, rtd.org seems to be fine with these requirements. The problem I have been seeing is a `undefined` sprinkled in the `requestUrl` variable in Sphinx's `searchtools.js` which causes page loads to fail for previewing the search hits. Maybe this problem will disappear in the regular build on rtd.org. Squashed commits: * Fix search on readthedocs.org by bumping sphinx_rtd_theme to 1.2.2 1.2.2 includes PR 1448 which fixes issue 1452 - readthedocs/sphinx_rtd_theme#1448 - readthedocs/sphinx_rtd_theme#1452 * Fixup: remove `html_theme_path` Suggested in readthedocs/sphinx_rtd_theme#1452 (comment) * Fixup 2: or, add 'sphinxcontrib.jquery' to 'extensions' * Fixup 3: bump to latest Sphinx and rtd theme
readthedocs/sphinx_rtd_theme#1452 Bumped Sphinx and RTD theme
Workaround for readthedocs/sphinx_rtd_theme#1452
Symptom
Uncaught ReferenceError: jQuery is not defined
Issue
Sphinx signal
config-inited
has probably already been called when we try to add a hook.Fixed by
#1448
Workaround
The current workaround is to add
sphinxcontrib.jquery
toextensions
inconf.py
The text was updated successfully, but these errors were encountered: