GNOME Bugzilla – Bug 660325
Documentation browser
Last modified: 2018-07-10 22:05:53 UTC
[ Originally filed by Olivier Lê Thanh Duong as http://www.reinteract.org/trac/ticket/80 ] A nice addition to have would be an easy access to the documentation for a class or a module, by keyboard shortcut or contextual menu, possibly in a separate windows. Maybe something like the devhelp assistant : http://people.imendio.com/richard/archives/2008/10/devhelp_assista_1.html
Right now, the best way to browse the docs for a module is likely to type: <module>. let it complete, then arrow up in down in the completion looks. You can also do help(module) and have it formatted inline, but I can see where for browsing the docs for a module, having that in a separate window or in a "pane" could provide a better experience than tooltip.On the other hand, the more panes/windows we have, the more Reinteract looks like an IDE rather than a simple friendly tool.
Created attachment 199886 [details] [review] Add option to display help in the sidebar The sidebar might offer a useful place to display documentation. Here's a proof-of-concept to allow help() to use the sidebar with display='side'. It would work better if the widget could find out the sidebar's width. The GUI code should probably be moved somewhere other than notebook.py.
Created attachment 200380 [details] [review] Add option to display resizable help in the sidebar This uses Owen's patch to allow the help widget to know the sidebar width. It can be sluggish right now for long help items; I don't know if that can be fixed just within this particular custom result or not.
Reinteract is not under active development anymore and had its last code changes in early 2012: http://git.fishsoup.net/cgit/reinteract/log/ Closing this report as WONTFIX as part of Bugzilla Housekeeping to reflect reality. Please feel free to reopen this ticket (or rather transfer the project to GNOME Gitlab, as GNOME Bugzilla is deprecated) if anyone takes the responsibility for active development again.