Search not working in 1.2.0 in environments without web access #1434

tmct · 2023-02-08T15:09:07Z

Problem

Hi,

When I upgrade to 1.2.0, the "search" feature stops working in airgapped environments. When a search is initiated, it "spins" but does not finish.

Also observed:

on load, the webpage tries to access https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js upon load, and this fails in environments with no internet access, as expected
"Uncaught ReferenceError: jQuery is not defined" happens when you initiate a search

Reproducible Project

Cannot share, sorry - but it shouldn't matter

Error Logs/Results

See above

Expected Results

Search completes as expected

Environment Info

Python Version: 3.8 and 3.9
Sphinx Version: 6.1.3
RTD Theme Version: 1.2.0

benjaoming · 2023-02-08T15:33:55Z

@tmct we forced the version of sphinxcontrib-jquery to exclude 3.0.0 because there were incoming reports that jQuery wasn't loaded in local builds because of an SRI integrity check. See: #1420

If you can force-feed pip sphinxcontrib-jquery==3.0.0, you should be able to serve an airgapped build.

This will be finally fixed by a new version of sphinxcontrib-jquery: sphinx-contrib/jquery#14

tmct · 2023-02-08T17:24:33Z

Thanks very much! I'll keep an eye on that sphinxcontrib-jquery change.

benjaoming · 2023-03-15T15:08:42Z

@tmct you can also try reinstalling now, that should give you sphinxcontrib-jquery==4.1 which has resolved the issue generally.

gherceg · 2023-03-16T19:08:25Z

@benjaoming we are experiencing a similar issue, but after upgrading sphinxcontrib-jquery to 4.1 (with sphinx==6.1.3 and sphinx-rtd-theme==1.2), the "Uncaught ReferenceError: jQuery is not defined" error still occurs when using the search bar.

benjaoming · 2023-03-16T19:21:21Z

@gherceg thanks for the feedback!! do you have a build log, a link to the documentation and/or a git repo that I can have a look at?

gherceg · 2023-03-16T19:51:13Z

Yeah of course. commcare-hq is the repository, and the docs are here, but notably that docs build is still running sphinxcontrib-jquery==2.0.0, with the same versions for sphinx and sphinx-rtd-theme mentioned above.

benjaoming · 2023-03-16T20:10:38Z

@gherceg ah! I recognize this issue. Default setups aren't affect by this: We removed html_theme_path from the injected default configuration for Sphinx projects on Read the Docs (because this setting breaks stuff), but very old instructions mentioned to define html_theme_path, so that's probably where you originally got it into your own conf.py. The setting unfortunately switches off the theme's ability to automatically enable the sphinxcontrib-jquery extension, so you either have to enable the extension manually or remove html_theme_path from conf.py. Since it's unnecessary to have this setting, you can just remove it as suggested in dimagi/commcare-hq#32760 👍

(after multiple edits: I think it makes sense now, but LMK if there's something unclear)

readthedocs/sphinx_rtd_theme#1434

see readthedocs/sphinx_rtd_theme#1434 (comment) for details Change-Id: I890ae6c9329fac3bc5f4f004c33b2386cd183557 Reviewed-on: https://forge.frm2.tum.de/review/c/frm2/nicos/nicos/+/32460 Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de> Reviewed-by: Bjoern Pedersen <bjoern.pedersen@frm2.tum.de>

see readthedocs/sphinx_rtd_theme#1434 (comment) for details Change-Id: I890ae6c9329fac3bc5f4f004c33b2386cd183557 Reviewed-on: https://forge.frm2.tum.de/review/c/frm2/nicos/nicos/+/32460 Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de> Reviewed-by: Bjoern Pedersen <bjoern.pedersen@frm2.tum.de> (cherry picked from commit d8e2eb9) Reviewed-on: https://forge.frm2.tum.de/review/c/frm2/nicos/nicos/+/32461

The `html_theme_path` option should not be used any more with sphinx-rtd-theme since it switches off the theme's ability to automatically enable the sphinxcontrib-jquery extension, i.e. jQuery is not loaded in the web pages when building the docs with Sphinx >=6. xref: readthedocs/sphinx_rtd_theme#1434 (comment) Also replace the deprecated `canonical_url` theme option with Sphinx's `html_baseurl`. xref: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-canonical_url

There is a documented issue where the deprecated variable, html_theme_path has caused the search feature to break. readthedocs/sphinx_rtd_theme#1434 (comment)

see readthedocs/sphinx_rtd_theme#1434 (comment) No longer need to define html_theme_path

humitos · 2024-08-12T15:11:06Z

Is this still an issue? If so, can you point us to a live project hitting this issue (or instructions to reproduce it) ?

LGouellec · 2024-08-12T17:47:26Z

Try https://lgouellec.github.io/streamiz/index.html, Search "Branch" in the search tab, it "spins" but does not finish. Same for any other words.

humitos · 2024-08-12T18:07:41Z

@LGouellec what version of the theme are you using? what's the version of Sphinx itself? Can you try using the latest version of the theme?

LGouellec · 2024-08-12T18:59:21Z

I tried the last one 2.0.0, but without effects

https://github.com/LGouellec/streamiz/blob/master/.github/workflows/gh-pages.yml

humitos · 2024-08-13T10:34:30Z

@LGouellec the error in the browser's console says: Uncaught ReferenceError: jQuery is not defined. So, I think 2.0.0 is not being installed correctly. What's the output of the build process? Is this one https://github.com/LGouellec/streamiz/actions/runs/10357412706/job/28669387744?

LGouellec · 2024-08-13T22:47:31Z

@humitos Yes it's this one, full raw logs available here : https://productionresultssa16.blob.core.windows.net/actions-results/30612698-4096-4adc-bf39-e74cb39f2037/workflow-job-run-ef53817e-be1e-5b9f-8d47-e63fd9dfbe04/logs/job/job-logs.txt?rsct=text%2Fplain&se=2024-08-13T22%3A56%3A16Z&sig=Jb7RxTBKatInP8gQ10cAPBnX%2FACCLlw80n1z7RpFuM8%3D&ske=2024-08-14T07%3A52%3A48Z&skoid=ca7593d4-ee42-46cd-af88-8b886a2f84eb&sks=b&skt=2024-08-13T19%3A52%3A48Z&sktid=398a6654-997b-47e9-b12b-9515b896b4de&skv=2024-05-04&sp=r&spr=https&sr=b&st=2024-08-13T22%3A46%3A11Z&sv=2024-05-04

humitos · 2024-08-13T23:10:05Z

I can't open that URL, AuthenticationFailed

LGouellec · 2024-08-13T23:39:52Z

0_build-and-deploy.txt

humitos · 2024-08-14T10:06:48Z

From that build output, everything looks correct to me:

2024-08-12T18:35:05.9826720Z   Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl.metadata (4.4 kB)
2024-08-12T18:35:06.0110510Z   Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)

I'm not sure why it's not working. If you provide a minimal reproducible example, we can debug further. However, I still think it's a problem in your environment/configuration.

humitos · 2024-08-14T10:08:12Z

I notice that you don't have the theme added as an extension in https://github.com/LGouellec/streamiz/blob/master/docs/conf.py#L33 as our documentation mentions https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html. Can you try that?

LGouellec · 2024-08-14T17:42:47Z

@humitos ,

I have added the extension and now it works ! Thank you for your support.

Remove obsolete html_theme_path setting from doc/walt/doc/sphinx/conf.py. This was causing the search function to fail, as described here: readthedocs/sphinx_rtd_theme#1434

tmct added Bug A bug Needed: replication Bug replication is required labels Feb 8, 2023

dkliban mentioned this issue Feb 14, 2023

The search in the pulpcore documentation is broken pulp/pulpcore#3569

Closed

DelazJ mentioned this issue Feb 21, 2023

Search bar is not working qgis/pyqgis-api-docs-builder#109

Closed

benjaoming mentioned this issue Mar 16, 2023

Docs: Remove legacy sphinx_rtd_theme configuration dimagi/commcare-hq#32760

Merged

gherceg mentioned this issue Mar 16, 2023

Resolve search bar issue in sphinx docs dimagi/commcare-hq#32761

Merged

3 tasks

btravouillon mentioned this issue Mar 30, 2023

Search box seems broken. mila-iqia/mila-docs#167

Closed

RogerHaase mentioned this issue May 6, 2023

Searching the docs yields no response moinwiki/moin#1425

Closed

martinhoyer mentioned this issue May 23, 2023

Fix search function in docs teemtee/tmt#2107

Merged

JonnyWong16 mentioned this issue Aug 1, 2023

Fix documentation search pkkid/python-plexapi#1201

Merged

7 tasks

ThomasRuby added a commit to squirrel-prover/squirrel-prover that referenced this issue Oct 26, 2023

[doc] fix for search see ↓ for more info

85d3030

readthedocs/sphinx_rtd_theme#1434

miek mentioned this issue Nov 2, 2023

Remove html_theme_path setting from docs config to fix search & other JavaScript functions scikit-rf/scikit-rf#970

Merged

nsoranzo mentioned this issue Apr 4, 2024

[24.0] Fix search and version menu in docs galaxyproject/galaxy#17898

Merged

4 tasks

rbyh mentioned this issue Apr 18, 2024

Search not working for readthedocs theme expectedparrot/edsl#316

Closed

LGouellec mentioned this issue Jun 20, 2024

Search not working on the documentation site LGouellec/streamiz#327

Closed

8 tasks

zwall-bp added a commit to osuosl/wiki that referenced this issue Jul 3, 2024

Comment out html_theme_path to patch search

ea31c4c

There is a documented issue where the deprecated variable, html_theme_path has caused the search feature to break. readthedocs/sphinx_rtd_theme#1434 (comment)

zwall-bp mentioned this issue Jul 3, 2024

Comment out html_theme_path to patch search osuosl/wiki#164

Merged

dliptai added a commit to ADACS-Australia/OzSTAR-User-Guide that referenced this issue Aug 1, 2024

fix broken search bar

59cc400

see readthedocs/sphinx_rtd_theme#1434 (comment) No longer need to define html_theme_path

humitos added Support Support question and removed Bug A bug Needed: replication Bug replication is required labels Aug 13, 2024

This was referenced Aug 19, 2024

Do not use theme as extension, this should be made redundant #1479

Closed

Docs: do not install as Sphinx extension #1589

Closed

Docs: install theme as Sphinx extension may not be required #1222

Open

humitos closed this as not planned Won't fix, can't repro, duplicate, stale Sep 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search not working in 1.2.0 in environments without web access #1434

Search not working in 1.2.0 in environments without web access #1434

tmct commented Feb 8, 2023

benjaoming commented Feb 8, 2023

tmct commented Feb 8, 2023

benjaoming commented Mar 15, 2023

gherceg commented Mar 16, 2023

benjaoming commented Mar 16, 2023

gherceg commented Mar 16, 2023 •

edited

Loading

benjaoming commented Mar 16, 2023 •

edited

Loading

humitos commented Aug 12, 2024

LGouellec commented Aug 12, 2024

humitos commented Aug 12, 2024

LGouellec commented Aug 12, 2024

humitos commented Aug 13, 2024

LGouellec commented Aug 13, 2024

humitos commented Aug 13, 2024

LGouellec commented Aug 13, 2024

humitos commented Aug 14, 2024

humitos commented Aug 14, 2024

LGouellec commented Aug 14, 2024

Search not working in 1.2.0 in environments without web access #1434

Search not working in 1.2.0 in environments without web access #1434

Comments

tmct commented Feb 8, 2023

Problem

Reproducible Project

Error Logs/Results

Expected Results

Environment Info

benjaoming commented Feb 8, 2023

tmct commented Feb 8, 2023

benjaoming commented Mar 15, 2023

gherceg commented Mar 16, 2023

benjaoming commented Mar 16, 2023

gherceg commented Mar 16, 2023 • edited Loading

benjaoming commented Mar 16, 2023 • edited Loading

humitos commented Aug 12, 2024

LGouellec commented Aug 12, 2024

humitos commented Aug 12, 2024

LGouellec commented Aug 12, 2024

humitos commented Aug 13, 2024

LGouellec commented Aug 13, 2024

humitos commented Aug 13, 2024

LGouellec commented Aug 13, 2024

humitos commented Aug 14, 2024

humitos commented Aug 14, 2024

LGouellec commented Aug 14, 2024

gherceg commented Mar 16, 2023 •

edited

Loading

benjaoming commented Mar 16, 2023 •

edited

Loading