octave-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Octave-bug-tracker] [bug #44529] make doc function aware of package doc


From: Andrew Janke
Subject: [Octave-bug-tracker] [bug #44529] make doc function aware of package documentation files
Date: Fri, 18 Jan 2019 21:11:16 -0500 (EST)
User-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36

Follow-up Comment #8, bug #44529 (project octave):

Bringing discussion from bug #55509 over here.

QHelp is the native format for the doc browser in Qt Octave, so maybe we could
add support to pkg() and doc() for that (and possibly other formats).

If you have a .qch QHelp format file, it's currently not too hard to add it to
the doc browser, by using Octave's internal __octave_link_register_doc__
function.

Packages' QHelp files should probably be generated by the packages themselves
at package distribution creation time. That way users don't have to have the
Qt development tools set up on their machines just to install packages or view
their doco. (Especially on Windows; that sounds like a pain.)

I've hacked together some code to generate QHelp for my Chrono package, as an
example: https://github.com/apjanke/octave-addons-chrono/tree/master/doc.

Right now, Chrono is using a PKG_ADD/PKG_DEL kludge to register its QHelp
file. It seems to work; see GIF:
https://savannah.gnu.org/bugs/download.php?file_id=46013

We could extend the pkg metadata definition files to allow them to declare a
"QHelpFiles: " list (and maybe other help file formats), and have pkg register
them automatically during the "pkg load" process.

    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?44529>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/




reply via email to

[Prev in Thread] Current Thread [Next in Thread]