Search is broken in the documentation

[chausner-audeering]

The search is broken in the documentation, e.g.: https://audeering.github.io/audb/search.html?q=full_path&check_keywords=yes&area=default gives a JavaScript error:

Uncaught ReferenceError: Stemmer is not defined
    query https://audeering.github.io/audb/_static/searchtools.js:158
    setIndex https://audeering.github.io/audb/_static/searchtools.js:98
    <anonymous> https://audeering.github.io/audb/search.html?q=full_path&check_keywords=yes&area=default line 2 > injectedScript:1

We had this issue a while ago with other packages and it was fixed there by updating audeering-sphinx-theme or one of the other packages if I remember correctly.

[hagenw]

I guess you cannot remember where we fixed it, because I cannot.

[chausner-audeering]

I don't remember either. :( I suggest to look for a package where the search works and then check whether different versions of sphinx packages are used.

[hagenw]

I will. It could also be that this is affected by the order we load the different plugins in docs/conf.py as I remember that I solved some issue that way.

[hagenw]

So far, I haven't found a single documentation where the search is still working.

[hagenw]

It's a bug in the underlying RTD theme, see sphinx-doc/sphinx#8591

One workaround would be to use sphinx<3.4.0 and to fix it see how we can incorporate readthedocs/sphinx_rtd_theme#1021

[chausner-audeering]

Hmm, can't we just update the version of the RTD theme that we use?

[hagenw]

Hmm, can't we just update the version of the RTD theme that we use?

No, it's not that easy, the newer version of the RTD theme brake a lot of other stuff in our theme, so we have switched to an older version, see audeering/sphinx-audeering-theme#30

[hagenw]

This is now fixed with release 1.0.12 of sphinx-audeering-theme (audeering/sphinx-audeering-theme#31).
See https://audeering.github.io/sphinx-audeering-theme/search.html?q=test&check_keywords=yes&area=default

I will create a pull request to switch to the new version. You should do the same in other projects.