[Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Index chapters of manual poorly

[Pantxo Diribarne]

Follow-up Comment #24, bug #53006 (project octave):

My first try at having the qt help files generated by octave was unsucessfull
... but I can summarize what I think has to be done:
* Check the presence of both qhelpgenerator and qcollectiongenerator at
configure time, and define $(QCOLLECTIONGENERATOR) and $(QHELPGENERATOR)
* by default generate both .qch and .qhc for the interpreter, so that the
QHelpEngine (the help manager for the doc browser) can be initialized with a
default collection that only contains the interpreter documentation. The make
rule to produce interpreter_qthelp.qch and interpreter_qthelp.qhc should look
like:


$(OCTAVE_HTML_QTHELP):
        python $(srcdir)/doc/interpreter/prepare_qhelp.py \
         interpreter_qthelp ./octave.html
        $(QCOLLECTIONGENERATOR) interpreter_qthelp.qhcp -o 
interpreter_qthelp.qhc
        rm -f interpreter_qthelp.qhcp interpreter_qthelp.qhp


* if doxygen is run, generate the associated .qch file, which can be
registered by the QHelpEngine into the default collection at run time. For
this the diff in comment #20 must be modified to replace "qhelpgenerator" by
$(QHELPGENERATOR), found at configure time.
* All files, interpreter_qthelp.qch/qhc and eventually cpp-api_qthelp.qch,
should be installed in some convenient place where the GUI can access them
(share/doc?). There should also be an environment variable set by run-octave
(e.g. $OCTAVE_QTHELP_DIR) so that files can be located in the build tree.

I attached the modified python script that should be added in doc/interpreter.

(file #43259)
    _______________________________________________________

Additional Item Attachment:

File name: prepare_qhelp.py               Size:5 KB


    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?53006>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/