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

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

[Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Ind


From: Pantxo Diribarne
Subject: [Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Index chapters of manual poorly
Date: Thu, 8 Feb 2018 04:03:10 -0500 (EST)
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0

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

I tried to have doxygen generate the compressed help file for the c++ api and
it works pretty well. The following change in Doxyfile.in is enough to produce
it:


diff -r 7b6a5336ddb3 doc/doxyhtml/Doxyfile.in
--- a/doc/doxyhtml/Doxyfile.in  Tue Jan 09 08:56:31 2018 -0500
+++ b/doc/doxyhtml/Doxyfile.in  Wed Feb 07 23:36:59 2018 +0100
@@ -518,6 +518,52 @@
 GENERATE_TREEVIEW      = YES
 
 #---------------------------------------------------------------------------
+# Configuration options related to the Qt Compressed Help output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed
+# Help (.qch) of the generated HTML documentation.
+
+GENERATE_QHP           = YES
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to
+# specify the file name of the resulting .qch file. The path specified is
+# relative to the HTML output folder.
+
+QCH_FILE               = ./octave-cpp-api.qch
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt
Help
+# Project output.
+
+QHP_NAMESPACE          = "com.octave.cpp-api"
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output.
+
+QHP_VIRTUAL_FOLDER     = "doc"
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add.
+
+# QHP_CUST_FILTER_NAME
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add.
+
+# QHP_CUST_FILTER_ATTRS
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches.
+
+# QHP_SECT_FILTER_ATTRS
+
+# Where to find the qhelpgenerator
+
+QHG_LOCATION       = "qhelpgenerator"
+
+#---------------------------------------------------------------------------
 # Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
 


The only glitch I can see is that octave's logo is not included in the qch
file.

    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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