iris

iris copied to clipboard

📚 Documentation

The doc search seems broken at the moment. If I go to https://scitools-iris.readthedocs.io/en/stable/search.html?q=load_cube

I get

I would expect a link near the top of the list that takes me straight to https://scitools-iris.readthedocs.io/en/stable/generated/api/iris.html#iris.load_cube

but none of them do.

This is Read the Docs behaviour, and isn't unique to Iris (e.g. https://docs.xarray.dev/en/stable/search.html?q=dataset).

There may be some way to customise (Server side search). I'm not personally planning to look any further at this time.

I've taken a look at this. I cannot see anyway to improve the sphinx search results.

I did think about improving how the search results were presented through a "search as you type" extensions but that was hit and miss, see https://github.com/SciTools/iris/pull/5566.

Is this something that can be raised with RTD? It seems like a pretty big usability gap to not get the api docs for the exact thing you searched. In locally built docs it is the first result.