toga
toga copied to clipboard
beeware
Documentation search functionality seems hobbled
What is the problem or limitation you are having?
When using the search functionality on RTD, the results seem limited and less useful than they could be. Given the prominent search box is the obvious method to find arbitrary information in the documentation, this makes it harder to find what I'm looking for.
Describe the solution you'd like
Consider searching for "dialog"; ideally, the search result would include all of the dialog methods on Window. Instead, it only includes the stack_trace_dialog (and the presentation of the search result doesn't make even that clear).
This clearly isn't Toga functionality per se....but perhaps it's possible to improve how the search results behave.
Describe alternatives you've considered
If I know something exists but can't find it in the docs, I'll perform a GitHub search instead.
Additional context
No response
Interestingly, the search results from the docs built on my local machine are particularly more useful...
Odd... when I do it on the site, I get results for stack_trace_dialog, select_folder_dialog, and open_file_dialog. Though yes, the presentation of them is unhelpful. It looks like it's only searching for the entire word, so it finds it as a return type and occurring in text, but not the method names themselves.
What's also odd is that my locally built version lists the same results as yours, but without the highlighted text summaries yours has.
This still really bothers me....and it isn't even that RTD and locally built docs handle search differently....docs built for PRs on RTD work while search for stable docs are bad....