Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs search is broken #2040

Closed
ewels opened this issue Apr 14, 2021 · 4 comments
Closed

Docs search is broken #2040

ewels opened this issue Apr 14, 2021 · 4 comments

Comments

@ewels
Copy link
Member

ewels commented Apr 14, 2021

Since a week or more ago, the docs search just hangs and never loads: https://www.nextflow.io/docs/latest/search.html?q=duration&check_keywords=yes&area=default

The browser console shows this:

Uncaught ReferenceError: Stemmer is not defined
    at Object.query (searchtools.js:158)
    at Object.setIndex (searchtools.js:98)
    at <anonymous>:1:8
    at b (jquery.js:2)
    at Function.globalEval (jquery.js:2)
    at text script (jquery.js:2)
    at jquery.js:2
    at l (jquery.js:2)
    at XMLHttpRequest.<anonymous> (jquery.js:2)
@pditommaso
Copy link
Member

@abhi18av can you give it a look ?

@abhi18av
Copy link
Member

Sure, I gave it a look and here's what I found.

  1. The problem is due to a bug in the newer sphinx release as mentioned here Search never stops searching, fails sphinx-doc/sphinx#8623 and Searching docs broken: Stemmer is not defined neuronsimulator/nrn#888.
  2. I think we can mitigate it by pinning the sphinx version on the CI
  3. I tried building locally with the sphinx-2.1.2 and the search is working fine.

@pditommaso
Copy link
Member

Solved upgrading sphynx theme to 0.5.2 4a165f4

@LyleLee
Copy link

LyleLee commented May 14, 2021

Solved upgrading sphynx theme to 0.5.2 4a165f4

Upgrade sphinx-rtd-theme to 0.5.2 worked fine with me. Thanks.

pip install -U sphinx-rtd-theme
Installing collected packages: sphinx-rtd-theme
  Attempting uninstall: sphinx-rtd-theme
    Found existing installation: sphinx-rtd-theme 0.5.0
    Uninstalling sphinx-rtd-theme-0.5.0:
      Successfully uninstalled sphinx-rtd-theme-0.5.0
Successfully installed sphinx-rtd-theme-0.5.2

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants