[issue15693] expose glossary link on hover
New submission from Chris Jerdonek: It would be nice if hovering over the right side of the header to a glossary entry would expose a link in the same way that it does for function definitions, etc. http://docs.python.org/dev/glossary.html#glossary Otherwise, there doesn't seem to be a convenient way to get a direct link to a glossary entry. I'm not sure if this issue should also be filed with Sphinx. ---------- assignee: docs@python components: Documentation messages: 168388 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: expose glossary link on hover type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
R. David Murray added the comment: I think it probably should be filed with sphinx instead, rather than also. ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Chris Jerdonek added the comment: Do we pin the version of Sphinx that we use to generate the documentation? If Sphinx fixes the issue, would we need to make a corresponding change here to reflect the fix? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
R. David Murray added the comment: We do pin it, but we generally have no problem with upgrading. I think we generally upgrade it exactly when there is a new Sphinx feature we want for our docs :) We don't maintain local patches to Sphinx (though we do have code that is specific to our docs, using Sphinx's extension mechanisms). ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Chris Jerdonek added the comment:
I think we generally upgrade it exactly when there is a new Sphinx feature we want for our docs :)
:) Would the appropriate way to handle it be then to create an issue to "upgrade Sphinx when XXX issue is resolved" and link to the corresponding Sphinx issue? I also see value in Python being able to track and possibly assist Sphinx in fixing an issue that we want. Incidentally, issue 15455 may fall into the same category now that I know more. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
R. David Murray added the comment: Well, I think it depends on what we consider the priority of the issue. So, I personally would count this one as low, and would be happy that it gets fixed whenever we happen to upgrade to a version of Sphinx that fixes it. If it is an issue we consider higher priority, then yes linking to the corresponding Sphinx issue here would be appropriate, and we have done that in the past. (My notions are of course not the sole determining factor on the priority.) In case you don't know, Georg is the primary author/maintainer of Sphinx, and I'm sure he'll be happy for any help you (or others) want to provide :). By the way, although I use it on my own site I'm not by any means a Sphinx expert, so my thoughts about where this should be changed could be wrong. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Chris Jerdonek added the comment: I created a Sphinx issue for this here: https://bitbucket.org/birkenfeld/sphinx/issue/996/expose-glossary-entry-link... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Chris Jerdonek added the comment: I submitted a patch for this issue on the Sphinx tracker. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Changes by Antoine Pitrou <pitrou@free.fr>: ---------- assignee: docs@python -> georg.brandl nosy: +georg.brandl stage: -> patch review type: enhancement -> behavior versions: +Python 3.1, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Changes by Antoine Pitrou <pitrou@free.fr>: ---------- stage: patch review -> needs patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- nosy: +brett.cannon _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Changes by Georg Brandl <georg@python.org>: ---------- assignee: georg.brandl -> _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Chris Jerdonek added the comment: It looks like the issue I previously filed on the Sphinx tracker was migrated here: https://github.com/sphinx-doc/sphinx/issues/996 . But the patch I submitted seems to have been dropped. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15693> _______________________________________
Change by Brett Cannon <brett@python.org>: ---------- nosy: -brett.cannon _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue15693> _______________________________________
Change by Irit Katriel <iritkatriel@yahoo.com>: ---------- versions: +Python 3.10, Python 3.8, Python 3.9 -Python 3.1, Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue15693> _______________________________________
participants (7)
-
Antoine Pitrou -
Brett Cannon
-
Chris Jerdonek
-
Ezio Melotti
-
Georg Brandl
-
Irit Katriel
-
R. David Murray