[issue34398] Docs search does not index glossary items

2019-02-06 Thread Cheryl Sabella
Cheryl Sabella added the comment: @ammar2, this looks like a great addition to the docs. Would you be able to address Berker's request and also fix the merge conflict on the PR? Also adding Julien and Carol from the expert's index for documentation. -- nosy: +cheryl.sabella, mdk, wi

[issue34398] Docs search does not index glossary items

2018-08-15 Thread Berker Peksag
Berker Peksag added the comment: Ammar's pull request looks good to me, but it would be nice to include the item's title in the box. I will add my comments about the design and implementation in the pull request. -- resolution: third party -> ___

[issue34398] Docs search does not index glossary items

2018-08-15 Thread Jonathan Fine
Jonathan Fine added the comment: Thank you for this, Ammar. Proof of concept solution is good progress. I'm well impressed. The screen shots convince me that it's well worth doing. For me, the one thing that's missing is a link just above the glossary item. Something like "Glossary: iterable

[issue34398] Docs search does not index glossary items

2018-08-15 Thread Ammar Askar
Ammar Askar added the comment: I think showing glossary results up top in the search page is a good idea, so I wrote up a quick proof of concept sphinx extension to do so. The diff isn't very big or complicated but it does need a bit of cleanup, especially the javascript and presentation sid

[issue34398] Docs search does not index glossary items

2018-08-15 Thread Ammar Askar
Change by Ammar Askar : -- keywords: +patch pull_requests: +8248 stage: -> patch review ___ Python tracker ___ ___ Python-bugs-list

[issue34398] Docs search does not index glossary items

2018-08-15 Thread Jonathan Fine
Jonathan Fine added the comment: You're right! Thank you. However, there's still a problem. A user searches for a technical term, and the carefully written glossary entry defining it does not appear. For my search term (iterable), there was a single entry with a link to the Glossary page, w

[issue34398] Docs search does not index glossary

2018-08-15 Thread Ammar Askar
Ammar Askar added the comment: Hmm, are you sure its not indexed? Look at this search result: https://docs.python.org/3/search.html?q=__slots__ The glossary page shows up in the results for me. Or are you suggesting that if you search for a term defined in the glossary, it be prominently sh

[issue34398] Docs search does not index glossary

2018-08-14 Thread Jonathan Fine
Jonathan Fine added the comment: Good discovery. The glossary uses the RST glossary directive. https://github.com/python/cpython/blob/master/Doc/glossary.rst The Sphinx docs have a glossary, which is indexed by its search. http://www.sphinx-doc.org/en/master/search.html?q=domain So maybe Sphi

[issue34398] Docs search does not index glossary

2018-08-14 Thread Mariatta Wijaya
Mariatta Wijaya added the comment: Hmm the search is built-in functionality in Sphinx, and I don't think we have any way to control or customize that. -- nosy: +Mariatta resolution: -> third party status: open -> pending versions: -Python 2.7, Python 3.4, Python 3.5 ___

[issue34398] Docs search does not index glossary

2018-08-14 Thread Jonathan Fine
New submission from Jonathan Fine : The docs contain a very useful page https://docs.python.org/3.5/glossary.html. However, the search feature does not index the glossary. Thus, the search https://docs.python.org/3.5/search.html?q=iterable does not produce the helpful glossary entry === itera