This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: sphinx search, result sorting
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: later
Dependencies: Superseder:
Assigned To: Nosy List: docs@python, georg.brandl, guettli, r.david.murray
Priority: normal Keywords:

Created on 2013-09-17 07:01 by guettli, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg197963 - (view) Author: Thomas Guettler (guettli) * Date: 2013-09-17 07:01
If you search for "printf" in the docs you get this result:

http://docs.python.org/3.3/search.html?q=printf&check_keywords=yes&area=default

Please have a look at the first results. I guess most people don't want to see docs about "PyOS_snprintf"

Most people want to see this: http://docs.python.org/3.3/library/stdtypes.html?highlight=printf#printf-style-string-formatting

The good page (stdtypes.html) is the fourth search result.
And this page is huge. Unfortunately the link from the search result does not link to the section, it links to the top of the page.

 Since "printf" is in the heading, sphinx should be able to create a link to the relevant section in this page (in this example #printf-style-string-formatting).


Thank you
msg197988 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2013-09-17 14:10
This is a Sphinx issue and should be reported on the Sphinx tracker...although I think Sphinx uses a 3rd party tool for the sorting, so it might go back up even a level further :).  

I don't think there's any reason to keep this issue open here, but I'll leave that up to Georg.
msg198009 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2013-09-18 09:05
Searching in headings is implemented in Sphinx 1.2 (soon to be released).  We'll switch to that version at least for 3.3 and 3.4 when it's out, so you will get the result for the heading there.

The PyOS_snprintf will still be the first result, since results in "object names" are always the first preference.  But the second preference will be heading names.
msg198010 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2013-09-18 09:05
Searching in headings is implemented in Sphinx 1.2 (soon to be released).  We'll switch to that version at least for 3.3 and 3.4 when it's out, so you will get the result for the heading there.

The PyOS_snprintf will still be the first result, since results in "object names" are always the first preference.  But the second preference will be heading names.
History
Date User Action Args
2022-04-11 14:57:51adminsetgithub: 63239
2013-09-18 09:05:56georg.brandlsetmessages: + msg198010
2013-09-18 09:05:54georg.brandlsetstatus: open -> closed
resolution: later
messages: + msg198009
2013-09-17 14:10:04r.david.murraysetassignee: docs@python ->

messages: + msg197988
nosy: + r.david.murray, georg.brandl
2013-09-17 07:01:40guettlicreate