Infinite Loading on search in Kolibri Documentation Search about kolibri

[nucleogenesis]

I just replicated this and seems like search.html is getting a jQuery is not defined error, possibly the cause of the issue. Thanks for the report @siddeshas07 !

[siddeshas07]

hi @nucleogenesis , can you help me locate the search.html https://github.com/learningequality/kolibri/tree/develop/docs , I'm not able to find it under the kolibri , i tried searching in index.rst the but not able find it , i observed kolibri use the reStructuredText for docs , I'm not familiar with it can you please tell the file where search function is present.

[rtibbles]

According to our old friend @benjaoming, the workaround for this may be to add in a specific extension to our extensions configuration:
readthedocs/sphinx_rtd_theme#1452 (comment)

extensions = [
    "sphinxcontrib.jquery",
]

in the docs/conf.py (if there's already an extensions variable in there, this line should be added).

[rtibbles]

Alternatively, it may just be that we need to update the sphinx-rtd-theme package? But it's unpinned, so I am not sure why it's not updated!

[benjaoming]

@rtibbles yes, that looks like the issue caused by Sphinx removing jquery. You should actually pin sphinx-rtd-theme (and everything else, including Sphinx) since that'll avoid breakage in general.

In order to be sure about python package versions installed in the documentation build, check your RTD build log, since the RTD Sphinx builder injects various things during the build - I don't work there anymore, so I'll keep it at the shallow support :)

[rtibbles]

We had the exact opposite issue, unfortunately, where the pinning was causing breakage, hence the unpinning. Will check the log to verify.