Skip to content
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.

Sign up for GitHub

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

Jump to bottom

jQuery not loaded automatically with sphinxcontrib-jquery 4.0.0 #1452

Closed
benjaoming opened this issue Mar 30, 2023 · 12 comments · Fixed by #1448
Closed

jQuery not loaded automatically with sphinxcontrib-jquery 4.0.0 #1452

benjaoming opened this issue Mar 30, 2023 · 12 comments · Fixed by #1448
Labels
Bug A bug

Comments

@benjaoming
Copy link
Contributor

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 to extensions in conf.py
@benjaoming benjaoming added the Bug A bug label Mar 30, 2023
@benjaoming benjaoming mentioned this issue Mar 30, 2023
Closed
@valeriupredoi valeriupredoi mentioned this issue Mar 30, 2023
Merged
6 tasks
@stsewd
Copy link
Member

stsewd commented Mar 30, 2023

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 stsewd mentioned this issue Mar 30, 2023
Closed
@benjaoming
Copy link
Contributor Author

@stsewd that's a clarification of the description content?

@stsewd
Copy link
Member

stsewd commented Mar 30, 2023

@benjaoming just a workaround for users hitting this problem, feel free to put that in the description!

@benjaoming
Copy link
Contributor Author

@stsewd it was already there, so I was confused if you were writing it differently :)

@benjaoming benjaoming mentioned this issue Mar 30, 2023
Merged
@stsewd
Copy link
Member

stsewd commented Mar 30, 2023

oh, missed that!

@zacharyburnett zacharyburnett mentioned this issue Apr 4, 2023
Merged
7 tasks
@takluyver takluyver mentioned this issue Apr 6, 2023
Closed
takluyver added a commit to European-XFEL/EXtra-data that referenced this issue Apr 6, 2023
@takluyver
Fix search in RTD docs
ea5d045 
With a workaround suggested in readthedocs/sphinx_rtd_theme#1452
@takluyver takluyver mentioned this issue Apr 6, 2023
Merged
@rflamary rflamary mentioned this issue Apr 7, 2023
Merged
4 tasks
skirpichev added a commit to skirpichev/diofant that referenced this issue Apr 8, 2023
@skirpichev
Add jquery to extensions
64f53e7 
To workaround readthedocs/sphinx_rtd_theme#1452
@maxgerhardt
Copy link

Also just hit this error and #1452 (comment) solved the issue.

@stsewd stsewd mentioned this issue Apr 10, 2023
Closed
skirpichev added a commit to skirpichev/diofant that referenced this issue Apr 11, 2023
@skirpichev
Add jquery to extensions
39d8c76 
To workaround readthedocs/sphinx_rtd_theme#1452
@stsewd stsewd mentioned this issue Apr 12, 2023
Closed
douglas-raillard-arm added a commit to douglas-raillard-arm/lisa that referenced this issue Apr 13, 2023
@douglas-raillard-arm
doc: Workaround broken flyout menu
c81cb4e 
Apply Workaround for broken flyout menu.

Bug report: readthedocs/readthedocs.org#10242
Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
Merged
douglas-raillard-arm added a commit to ARM-software/lisa that referenced this issue Apr 13, 2023
@douglas-raillard-arm
doc: Workaround broken flyout menu
1b3e042 
Apply Workaround for broken flyout menu.

Bug report: readthedocs/readthedocs.org#10242
Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
@Alnusjaponica Alnusjaponica mentioned this issue Apr 16, 2023
Merged
This was referenced Apr 18, 2023
Closed
Merged
@EwoutH EwoutH mentioned this issue Apr 21, 2023
Closed
dfelinto pushed a commit to dfelinto/blender-manual that referenced this issue Apr 21, 2023
Config: Workaround bug in sphinx theme causing search to not work
b12dd4f 
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
EwoutH added a commit to quaquel/EMAworkbench that referenced this issue Apr 24, 2023
@EwoutH
docs: conf.py: Implement search workaround
5433e08 
Implement a workaround to get search working again

readthedocs/sphinx_rtd_theme#1452 (comment)
EwoutH added a commit to quaquel/EMAworkbench that referenced this issue Apr 24, 2023
@EwoutH
Fix search in Readthedocs configuration with workaround
0cee3b4 
This commit fixes search by adding a workaround to the Readthedocs configuration.

For the workaround see readthedocs/sphinx_rtd_theme#1452 (comment)
manu0x0 pushed a commit to isc-projects/bind9 that referenced this issue Aug 29, 2023
@nicki-krizek
Update sphinx_rtd_theme
8bd5468 
To resolve the version select and search issue on readthedocs.org,
sphinx_rtd_theme>=1.2.1 is required.

Related readthedocs/sphinx_rtd_theme#1452

(cherry picked from commit 92143fa)
manu0x0 pushed a commit to isc-projects/bind9 that referenced this issue Aug 29, 2023
@nicki-krizek
Update sphinx_rtd_theme
6e4f5d0 
To resolve the version select and search issue on readthedocs.org,
sphinx_rtd_theme>=1.2.1 is required.

Related readthedocs/sphinx_rtd_theme#1452

(cherry picked from commit 92143fa)
@andreasabel andreasabel mentioned this issue Sep 5, 2023
Merged
andreasabel added a commit to agda/agda that referenced this issue Sep 5, 2023
@andreasabel
Fix search on readthedocs.org by bumping sphinx_rtd_theme to 1.2.2
5fad90e 
1.2.2 includes PR 1448 which fixes issue 1452

- readthedocs/sphinx_rtd_theme#1448
- readthedocs/sphinx_rtd_theme#1452
andreasabel added a commit to agda/agda that referenced this issue Sep 5, 2023
@andreasabel
Fixup: remove html_theme_path
2a5f363 
Suggested in readthedocs/sphinx_rtd_theme#1452 (comment)
andreasabel added a commit to agda/agda that referenced this issue Sep 5, 2023
@andreasabel
Fix search on readthedocs.org (#6821)
2fcfdd1 
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
@Piralein Piralein mentioned this issue Oct 2, 2023
Draft
@astrojuanlu astrojuanlu mentioned this issue Oct 18, 2023
Closed
kccwing referenced this issue in ImperialCollegeLondon/sharpy Oct 18, 2023
@kccwing
Update requirements_rtd
b938c5f
@kccwing kccwing mentioned this issue Oct 18, 2023
Merged
@miek miek mentioned this issue Nov 2, 2023
Merged
jieter added a commit to jieter/django-tables2 that referenced this issue Nov 13, 2023
@jieter
Fix search (readthedocs/sphinx_rtd_theme#1452)
cea629e
jieter added a commit to jieter/django-tables2 that referenced this issue Nov 13, 2023
@jieter
Update docs dependencies; fix docs search; add readthedocs.yaml (#935)
35f9616 
fixes: #925

Fix for missing jquery in search: readthedocs/sphinx_rtd_theme#1452
@michaeljpeters michaeljpeters mentioned this issue Nov 15, 2023
Merged
@khanspers khanspers mentioned this issue Nov 21, 2023
Closed
@jertel jertel mentioned this issue Dec 3, 2023
Merged
6 tasks
@lbianchi-lbl lbianchi-lbl mentioned this issue Dec 14, 2023
Closed
cznic-knotbot pushed a commit to CZ-NIC/knot-resolver that referenced this issue Jan 9, 2024
@Spiffyk
doc/conf.py: add 'sphinxcontrib.jquery'
fb313ef 
This works around cases where Sphinx does not add jQuery automatically
on some local setups <readthedocs/sphinx_rtd_theme#1452>.
cznic-knotbot pushed a commit to CZ-NIC/knot-resolver that referenced this issue Jan 9, 2024
@Spiffyk
doc/conf.py: add 'sphinxcontrib.jquery'
c7fc025 
This works around cases where Sphinx does not add jQuery automatically
on some local setups <readthedocs/sphinx_rtd_theme#1452>.
johnbywater added a commit to pyeventsourcing/eventsourcing that referenced this issue Jan 21, 2024
@johnbywater
Added 'sphinxcontrib.jquery' in Sphinx config extentions.
0b6d856 
readthedocs/sphinx_rtd_theme#1452
@jgray-19 jgray-19 mentioned this issue Jan 27, 2024
Merged
kdesysadmin pushed a commit to KDE/documentation-docs-kdenlive-org that referenced this issue Feb 17, 2024
@jlskuz
Try to fix jquery not loaded
51a58fb 
Workaround for readthedocs/sphinx_rtd_theme#1452
kdesysadmin pushed a commit to KDE/digikam-doc that referenced this issue Mar 4, 2024
@jlskuz
Fix jquery not loaded
02f5fab 
Workaround for readthedocs/sphinx_rtd_theme#1452
kgugala added a commit to antmicro/fomu-workshop that referenced this issue Mar 17, 2024
@kgugala
docs: insatall and load sphinxcontrib.jquery
3c8271f 
As per: readthedocs/sphinx_rtd_theme#1452

Signed-off-by: Karol Gugala <kgugala@antmicro.com>
@kgugala kgugala mentioned this issue Mar 17, 2024
Closed
kgugala added a commit to antmicro/fomu-workshop that referenced this issue Mar 17, 2024
@kgugala
docs: install and load sphinxcontrib.jquery
8e9aa0a 
As per: readthedocs/sphinx_rtd_theme#1452

Signed-off-by: Karol Gugala <kgugala@antmicro.com>
@pdurbin pdurbin mentioned this issue Apr 2, 2024
Merged
@rtibbles rtibbles mentioned this issue Apr 2, 2024
Closed
JobPetrovcic pushed a commit to JobPetrovcic/agda that referenced this issue Apr 12, 2024
@andreasabel @JobPetrovcic
Fix search on readthedocs.org (agda#6821)
44b7137 
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
@ksikka ksikka mentioned this issue Oct 9, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug A bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a call to add_js_files (sphinxcontrib.query) benjaoming/sphinx_rtd_theme
6 participants
@benjaoming @stsewd @richardsheridan @mikemhenry @EwoutH @maxgerhardt