desispec.readthedocs.io search function doesn't work?

[sbailey]

The search function of desispec.readthedocs.io doesn't appear to work. I just get a "Searching..." message that never seems to resolve into an answer. It is unclear to me whether this is a bug in readthedocs itself, or a bug in our config that prevents it from working.

Example search for "Spectra".

@weaverba137 please investigate. If it is a config problem on our side, please also check desiutil, desitarget, redrock, desimodel for similar issues. For some odd reason github isn't letting me assign the ticket to you.

I'm flagging this for DR1 in the hopes of getting our code docs updated and searchable for DR1.

[sbailey]

I was able to assign to @weaverba137 only after creating the ticket. Odd.

[weaverba137]

This sounds very much like desihub/desidatamodel#198, and should be easy to fix. I know desiutil is already updated, and I'll double check the others.

[sbailey]

@weaverba137 thanks for the quick fix. Please go ahead and self-merge your PRs, and then re-test the search fields after readthedocs has been updated. i.e. no need to wait for my review of each one. And then close this issue once all the packages have been updated.

[weaverba137]

I've added PRs for desitarget, redrock and desimodel. I think other packages can wait until next week.

[weaverba137]

Re-opening as a reminder to check other packages.

[weaverba137]

I have confirmed that search is working again on RTD for desispec. Other packages can be checked later.

[weaverba137]

I went through the packages that are included in desimodules:

• desiutil, updated a while ago
• desitree, no RTD docs
• specter, Update doc configuration specter#88
• gpu_specter, no RTD docs
• desimodel, Update RTD configuration desimodel#180
• specex, no RTD docs
• desitarget, Update RTD configuration desitarget#834
• specsim, does not use the RTD theme which causes the problem.
• desispec, Update RTD configuration #2446
• desisim, updated a while ago
• fiberassign, updated a while ago
• desisurvey, Update doc configuration desisurvey#162
• surveysim, Update doc configuration surveysim#85
• redrock, Update RTD configuration redrock#324
• redrock-templates, no RTD docs
• prospect, Update doc configuration prospect#104
• desimeter, no RTD docs
• simqso, DESI does not appear to have direct control over RTD configuration.
• speclite, does not use the RTD theme which causes the problem.
• QuasarNP, does not use the RTD theme which causes the problem.
• specprod-db, updated a while ago
• fastspecfit, Update doc configuration fastspecfit#214

Although they are not normally included in desimodules, these should also be updated, while we're at it:

• gfa_reduce, updated a while ago
• nightwatch, updated a while ago

Other packages will be updated at lower priority.

[weaverba137]

@sbailey, I wanted to give @moustakas a chance to review the fastspecfit PR, but otherwise I think everything is done, as far as possible anyway. Please take a look at the summary above.

[sbailey]

@weaverba137, great, thanks for the full search and update. Looks good. I confirm that the original issue with desispec.readthedocs.io search now works, and trust that the others do too. Closing.