Searching function in Developer Docs hangs

[candleindark]

What is the problem?

The searching function in Developer Docs hangs whenever one tries to do a search.

What steps will reproduce the problem?

Do a search of any term at https://docs.datalad.org/en/stable/.

DataLad information

No response

Additional context

No response

Have you had any success using DataLad before?

Yes, definitely.

[adswa]

Might be related this this: readthedocs/readthedocs.org#10263

[mslw]

I have this problem too - and also the bar on the lower left (where you can change version or find links to builds) doesn't work for me.

If the clue above is true, I want to add that the default versions of Sphinx and sphinx-rtd-teme depend on when the project was created, so DataLad gets the old ones. I followed the chain of links starting from yours a little bit, and saw that this StackOverflow answer blames the theme in particular.

Old versions had been a problem in DataLad-Neuroimaging for different reasons, see datalad/datalad-neuroimaging#119 and datalad/datalad-neuroimaging@a00c86e commit message for a workaround there.

[mslw]

Oki, I was wrong - we already declare an up-to-date dependency on Sphinx and sphinx-rtd-theme, and this is a bug in the latter, where jQuery is not loaded automatically (F12 when viewing docs shows an error, "jQuery is not defined").

The readthedocs issue you mentioned links to a workaround, i.e., adding this to the docs conf file:

extensions = [
    "sphinxcontrib.jquery",
]

I will add a PR with the change. Looking at the theme's issue tracker, it seems that a fix might be done in their next release (1.3.0), so we could also probably wait it out.

[yarikoptic-gitmate]

Issue fixed in 0.18.4