Title: prioritises search horribly
Type: enhancement Stage:
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7, Python 3.6
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, methane, xmorel
Priority: normal Keywords:

Created on 2020-10-21 09:59 by xmorel, last changed 2020-10-21 13:36 by xmorel.

Messages (3)
msg379203 - (view) Author: Xavier Morel (xmorel) * Date: 2020-10-21 09:59
I expect it simply uses sphinx and I don't know if sphinx's search is easily customisable but the experience is really terrible when looking for the doc of a specific thing, *especially* when that thing is or is related to a builtin, which I'd expect to be extremely common. Though I expect part of the issue might also be that builtin or ABC methods are not documented *as such*, they're just written as code in tables.

For instance if you search "append":

On my end, neither list nor MutableSequence appear anywhere on this page, even scrolling down.

Searching for "list":

The documentation for the builtin "list" object also doesn't appear on the page. "Data Structures"[0] and "built-in types"[1] appear below the fold and the former is genuinely useful but also very easy to miss (I had not actually noticed it before going back in order to get the various links and try to extensively describe the issue). Neither actually links to the `list` builtin type though.

Above the fold we find various "list" methods and classes from the stdlib as well as the PDB `list` comment, none of which seems like the best match for the query.

And even Google doesn't help much there, most of the hits are for third-party documentation, and the one link is to the Data Structures page *of Python 2.7*.

msg379206 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2020-10-21 12:46
Can we add search box using DuckDuckGo?
msg379207 - (view) Author: Xavier Morel (xmorel) * Date: 2020-10-21 13:36
Apparently it's at least a possibility on DDG's side (, don't know how easy it'd be to integrate in sphinx, or whether a hard dependency on an external search engine is acceptable / desirable.
Date User Action Args
2020-10-21 13:36:39xmorelsetmessages: + msg379207
2020-10-21 12:46:23methanesetnosy: + methane
messages: + msg379206
2020-10-21 09:59:57xmorelcreate