Merge pull request #3048 from nyalldawson/qt_doxygen

Allow generation of Qt QHP help files from doxygen
qgis · May 19, 2016 · 6f07322 · 6f07322
2 parents c0799d4 + 9d59f9c
commit 6f07322
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/cmake_templates/Doxyfile.in b/cmake_templates/Doxyfile.in
@@ -970,25 +970,25 @@ TOC_EXPAND             = NO
 # that can be used as input for Qt's qhelpgenerator to generate a
 # Qt Compressed Help (.qch) of the generated HTML documentation.
 
-GENERATE_QHP           = NO
+GENERATE_QHP           = @WITH_QHP@
 
 # 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               =
+QCH_FILE               =../qch/qgis.qch
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating
 # Qt Help Project output. For more information please see
 # http://doc.trolltech.com/qthelpproject.html#namespace
 
-QHP_NAMESPACE          = org.doxygen.Project
+QHP_NAMESPACE          = org.qgis.qgis2
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
 # Qt Help Project output. For more information please see
 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
 
-QHP_VIRTUAL_FOLDER     = doc
+QHP_VIRTUAL_FOLDER     = qgis
 
 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
 # add. For more information please see
@@ -1016,7 +1016,7 @@ QHP_SECT_FILTER_ATTRS  =
 # If non-empty doxygen will try to run qhelpgenerator on the generated
 # .qhp file.
 
-QHG_LOCATION           =
+QHG_LOCATION           = qhelpgenerator
 
 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
 #  will be generated, which together with the HTML files, form an Eclipse help

diff --git a/debian/control.in b/debian/control.in
@@ -62,6 +62,7 @@ Build-Depends:
  xfonts-base, xfonts-100dpi, xfonts-75dpi, xfonts-scalable,
 #oracle# oracle-instantclient12.1-devel,
  spawn-fcgi, lighttpd, poppler-utils, locales, qt4-doc-html,
+ qt4-dev-tools,
  libqt4-sql-sqlite, python-psycopg2
 Build-Conflicts: libqgis-dev, qgis-dev
 #sid stretch xenial#Standards-Version: 3.9.7

diff --git a/debian/rules b/debian/rules
@@ -65,6 +65,7 @@ CMAKE_OPTS := \
 	-DSERVER_SKIP_ECW=TRUE \
 	-DQGIS_CGIBIN_SUBDIR=/usr/lib/cgi-bin \
 	-DWITH_APIDOC=TRUE \
+	-DGENERATE_QHP=TRUE \
 	-DWITH_CUSTOM_WIDGETS=TRUE \
 	-DWITH_GLOBE=TRUE \
 	-DWITH_INTERNAL_HTTPLIB2=FALSE \

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -31,6 +31,14 @@ IF(WITH_APIDOC)
   FIND_PACKAGE(Doxygen 1.8.2 REQUIRED)
   IF(DOXYGEN_FOUND)
 
+    # Whether to generate QHP file
+    SET (GENERATE_QHP FALSE CACHE BOOL "Determines whether to generate Qt QHP help from the QGIS API Docs")
+    IF (GENERATE_QHP)
+      SET(WITH_QHP YES)
+    ELSE(GENERATE_QHP)
+      SET(WITH_QHP NO)
+    ENDIF(GENERATE_QHP)
+
     FIND_FILE(QT_TAG_FILE
       NAMES qt4.tags qt4.tag qt.tags qt.tag
       PATHS "${QT_DOC_DIR}"