The search feature at http://docs.yoctoproject.org/ is next to useless when searching for, say, strings that contain a period. Quentin Schulz suggests Algolia, discussed here: https://www.yoctoproject.org/irc/%23yocto.2020-10-05.log.html#t2020-10-05T09:08:38
Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.
*** Bug 15459 has been marked as a duplicate of this bug. ***
Another ticket was created regarding this issue: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15459. Some useful information was described in it, so I'm propagating useful info here and marking 15459 as duplicate. From Rob Wooley on 2024-03-26 18:31:35 UTC: > There are many terms in the documentation that have non-alphanumeric > characters. When searching for these terms on docs.yoctoproject.org, it > eliminates these characters and splits the term into separate words which > results in poor search results. > > Take the send-error-report script as an example. Searching for > send-error-report (with or without double quotes) gives many search results > that are not helpful because send, error, and report are common words: > https://docs.yoctoproject.org/search.html?q=send-error- > report&check_keywords=yes&area=default > > What it should have brought up was the page about using the script to send > error reports: eg. > https://docs.yoctoproject.org/dev-manual/error-reporting-tool.html Which > does appear as the second result, but largely because the tool is named > similarly to the topic. > > Searching for sstate-cache-management.py, also brings up a relevant page as > the second entry, however it also brings up a lot of false positives that > match "py". > > Another example is the "bitbake-layers" tool which has many matches for > "bitbake" and "layers", but has difficulty zeroing in on hits for the > bitbake-layers tool. My answer on 2024-12-24 10:28:02 UTC: > Indeed, I can also reproduce what you describe. > > For now, searching exact matches in Sphinx (what we use to generate the doc) > is not supported and is a known issue: > https://github.com/sphinx-doc/sphinx/issues/3301. > > There is a pull request from July on GitHub that attempts to solve the > issue: https://github.com/sphinx-doc/sphinx/pull/12552. > > As you can see, it is currently under discussion. I will keep track of the > issue to see if this gets merged and report here once we benefit from it.
I had the same issue in an internal documentation that uses sphinx-doc. Since the options for alternative search engines are quite limited, and the upstream discussions on similar issues all seemed to get stuck somewhere, I looked for a local solution/workaround for this problem and found a way to tweak the indexing and search handling. Since I encountered the same annoying behavior with the OE documentation, I wondered whether it was just me (which I'm sure it isn't, given this bug ticket) and whether my solution might be applicable here as well. My tests looked quite promising, thus I've sent my proposal to the list: https://lists.yoctoproject.org/g/docs/message/6795
I just noticed the upstream docs were regenerated with my patch applied. So searching for 'bitbake-layers', for example, works now: https://docs.yoctoproject.org/dev/search.html?q=bitbake-layers Do you think this is sufficient to mark this issue as 'resolved', or do we need further improvements?
I think it has certainly been improved. Thanks for contributing the fix. However, it still fails when you search for a term containing a period: "Searching for sstate-cache-management.py, also brings up a relevant page as the second entry, however it also brings up a lot of false positives that match 'py'. " I personally think that is important to have for people searching for specific scripts (eg. relocate_sdk.py) or bbclass files (eg archiver.bbclass) I would suggest leaving it open. Regards, Rob
TBH, I haven't searched for something YP-related that contained a period so far. Thus I did not cover this in my first approach. Admittedly, this issue has already noted the possible relevance of periods for searching. The handling can quite easily be extended to cover dots, too. If that's desired, I could make a follow-up patch.
Bulk move of bugs I am assigned to from Milestone 5.2M4 to 5.3M1.
(In reply to Enrico Jorns from comment #7) > TBH, I haven't searched for something YP-related that contained a period so > far. > Thus I did not cover this in my first approach. > Admittedly, this issue has already noted the possible relevance of periods > for searching. I think it makes sense to look for conf files, recipes, bbclass: local.conf, auto.conf, site.conf... I've found quite a few mentioned in the docs. > The handling can quite easily be extended to cover dots, too. > If that's desired, I could make a follow-up patch. I'd take a patch to try it out!
Hi, The following commit is now merged in master: https://git.yoctoproject.org/yocto-docs/commit/?id=80084a4cabdf7f61c7e93eda8ddbd5bc7d54e041 It allows searching for strings that include periods (local.conf, etc.). I'm closing this bug as I think it fixes the last issue mentioned here. Of course Sphinx search is not ideal, could probably be improved and better, but that would require changes in Sphinx. See above messages that reference open issues on Sphinx (Github). Thanks a lot Enrico for your contributions on this, much appreciated :) I'm moving this bug to Resolved fixed. Can be reopened if you feel more could be done on our side.