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: Using the lib index mechanically
Type: enhancement Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: fdrake, georg.brandl, jackjansen, theller
Priority: normal Keywords:

Created on 2002-04-03 22:02 by jackjansen, last changed 2022-04-10 16:05 by admin. This issue is now closed.

Messages (5)
msg60269 - (view) Author: Jack Jansen (jackjansen) * (Python committer) Date: 2002-04-03 22:02
If the HTML version of the index to the library documentation (http://www.python.org/doc/current/lib/genindex.html in the online version) would contain <A NAME="foo"> anchors at the first entry for the word "foo" in the index this would allow a really nice feature in the IDE (and IDLE, and other ide's): a command "lookup in documentation" that takes the current selection and sends your webbrowser to genindex.html#foo.

Or is there already another way to do this?

An alternative (more work, but would allow more features) would be to dump the information that is in the index in an XML file. During the index generation process there's probably more interesting info available too. And it would allow to search the indexes of multiple docsets at once (library, refmanual, etc).

I'm posting this as a feature request because I haven't even the beginning of an idea how to implement this (in all those years I haven't even succeeded in _building_ the documentation:-).
msg60270 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-07-21 15:47
Logged In: YES 
user_id=3066

The Python 2.4 documentation will provide an XML version of
the index data.  The specific information which can be
captured and the way it's expressed remain to be determined.
msg60271 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-07-21 15:50
Logged In: YES 
user_id=3066

I'll also note that once we have a process for generating
the XML version of the index data, it's likely that we can
apply it to older versions of the documentation to make them
similarly useful.
msg60272 - (view) Author: Thomas Heller (theller) * (Python committer) Date: 2003-07-21 15:57
Logged In: YES 
user_id=11105

At least there's this, and I've got my Xemacs to call it
when I press F5:
http://starship.python.net/crew/theller/pyhelp.cgi
msg61351 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-01-20 19:36
I think the upcoming 2.6 release will provide the necessary functions to
create such a feature.
History
Date User Action Args
2022-04-10 16:05:11adminsetgithub: 36373
2008-01-20 19:36:12georg.brandlsetstatus: open -> closed
assignee: fdrake -> georg.brandl
resolution: fixed
messages: + msg61351
nosy: + georg.brandl
2002-04-03 22:02:25jackjansencreate