summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2017-02-16 15:15:22 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2017-02-23 08:06:52 +0000
commit2dd93e76e19440f97f79a4d048905e26c01684b6 (patch)
tree27f12a15a0b2f3576d060500f641be1ffff46eb0
parentb24821ad3facc6f8e2a40edacba27cb888e878f8 (diff)
Doc: Switch to standard doc config and templates
Change-Id: I2d1a7d2d43f9b34cbdbcf964118258453a53b84a Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--.qmake.conf4
-rw-r--r--doc/doc.pri44
-rw-r--r--doc/doc.pro14
-rw-r--r--doc/online/qtwebbrowser.qdocconf (renamed from doc/qtwebbrowser-online.qdocconf)4
-rw-r--r--doc/qtwebbrowser-project.qdocconf (renamed from doc/config/qtwebbrowser-project.qdocconf)28
-rw-r--r--doc/qtwebbrowser.qdocconf4
-rw-r--r--qtwebbrowser.pro9
7 files changed, 38 insertions, 69 deletions
diff --git a/.qmake.conf b/.qmake.conf
new file mode 100644
index 0000000..1451dad
--- /dev/null
+++ b/.qmake.conf
@@ -0,0 +1,4 @@
+VERSION = 1.0.0
+
+# Set up documentation targets
+CONFIG += prepare_docs qt_docs_targets
diff --git a/doc/doc.pri b/doc/doc.pri
deleted file mode 100644
index 6ccd058..0000000
--- a/doc/doc.pri
+++ /dev/null
@@ -1,44 +0,0 @@
-HELPGENERATOR = $$shell_path($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal
-QDOC_BIN = $$shell_path($$[QT_INSTALL_BINS]/qdoc)
-QDOC_GLOBAL = QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS/src] QDOC_INDEX_DIR=$$[QT_INSTALL_DOCS]
-COMPAT =
-
-# unset the installdir for qdoc, so we force generation
-# of URLs for the links to the Qt documentation
-QMAKE_DOCS_INSTALLDIR =
-
-defineReplace(cmdEnv) {
- !equals(QMAKE_DIR_SEP, /): 1 ~= s,^(.*)$,(set \\1) &&,g
- return("$$1")
-}
-
-defineReplace(qdoc) {
- return("$$cmdEnv(OUTDIR=$$1 QTWEBBROWSER_VERSION=$$QTWEBBROWSER_VERSION QTWEBBROWSER_VERSION_TAG=$$QTWEBBROWSER_VERSION_TAG $$QDOC_GLOBAL) $$QDOC_BIN")
-}
-
-QHP_FILE = $$OUT_PWD/doc/html/qtwebbrowser.qhp
-QCH_FILE = $$OUT_PWD/doc/qtwebbrowser.qch
-
-HELP_DEP_FILES = $$PWD/src/qtwebbrowser.qdoc $$PWD/src/external-resources.qdoc
-
-html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtwebbrowser.qdocconf
-html_docs.depends += $$HELP_DEP_FILES
-html_docs.files = $$QHP_FILE
-
-html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtwebbrowser-online.qdocconf
-html_docs_online.depends += $$HELP_DEP_FILES
-
-qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
-qch_docs.depends += html_docs
-
-docs_online.depends = html_docs_online
-docs.depends = qch_docs
-QMAKE_EXTRA_TARGETS += qch_docs html_docs html_docs_online docs docs_online
-
-DISTFILES += \
- $$HELP_DEP_FILES \
- $$PWD/config/qtwebbrowser-project.qdocconf \
- $$PWD/qtwebbrowser.qdocconf \
- $$PWD/qtwebbrowser-online.qdocconf \
- $$PWD/images/src/block-diagram.qmodel
-
diff --git a/doc/doc.pro b/doc/doc.pro
new file mode 100644
index 0000000..3966427
--- /dev/null
+++ b/doc/doc.pro
@@ -0,0 +1,14 @@
+TEMPLATE = aux
+
+build_online_docs: \
+ QMAKE_DOCS = $$PWD/online/qtwebbrowser.qdocconf
+else: \
+ QMAKE_DOCS = $$PWD/qtwebbrowser.qdocconf
+
+DISTFILES += \
+ $$PWD/src/qtwebbrowser.qdoc \
+ $$PWD/src/external-resources.qdoc \
+ $$PWD/qtwebbrowser-project.qdocconf \
+ $$PWD/qtwebbrowser.qdocconf \
+ $$PWD/online/qtwebbrowser.qdocconf \
+ $$PWD/images/src/block-diagram.qmodel
diff --git a/doc/qtwebbrowser-online.qdocconf b/doc/online/qtwebbrowser.qdocconf
index 673d0f0..9aff055 100644
--- a/doc/qtwebbrowser-online.qdocconf
+++ b/doc/online/qtwebbrowser.qdocconf
@@ -1,9 +1,9 @@
-include(config/qtwebbrowser-project.qdocconf)
+include(../qtwebbrowser-project.qdocconf)
HTML.footer = \
" </div>\n" \
" <p class=\"copy-notice\">\n" \
- " <acronym title=\"Copyright\">&copy;</acronym> 2016 The Qt Company Ltd.\n" \
+ " <acronym title=\"Copyright\">&copy;</acronym> 2017 The Qt Company Ltd.\n" \
" Documentation contributions included herein are the copyrights of\n" \
" their respective owners. " \
" The documentation provided herein is licensed under the terms of the" \
diff --git a/doc/config/qtwebbrowser-project.qdocconf b/doc/qtwebbrowser-project.qdocconf
index d4570ca..3fe897c 100644
--- a/doc/config/qtwebbrowser-project.qdocconf
+++ b/doc/qtwebbrowser-project.qdocconf
@@ -1,25 +1,19 @@
-include($QT_INSTALL_DOCS/global/macros.qdocconf)
-include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
-include($QT_INSTALL_DOCS/global/compat.qdocconf)
-include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
-
project = "QtWebBrowser"
description = "Qt WebBrowser Manual"
-sourcedirs += ..
-imagedirs += ../images
-outputdir = $OUTDIR
+sourcedirs += src
+imagedirs += images
sources.fileextensions = "*.qdoc"
qhp.projects = QtWebBrowser
qhp.QtWebBrowser.file = qtwebbrowser.qhp
-qhp.QtWebBrowser.namespace = org.qt-project.qtwebbrowser.$$QTWEBBROWSER_VERSION_TAG
+qhp.QtWebBrowser.namespace = org.qt-project.qtwebbrowser.$$QT_VERSION_TAG
qhp.QtWebBrowser.virtualFolder = qtwebbrowser
qhp.QtWebBrowser.indexTitle = Qt WebBrowser
qhp.QtWebBrowser.filterAttributes = qtwebbrowser
-qhp.QtWebBrowser.customFilters.QtWebBrowser.name = Qt WebBrowser $QTWEBBROWSER_VERSION
-qhp.QtWebBrowser.customFilters.QtWebBrowser.filterAttributes = qtwebbrowser $QTWEBBROWSER_VERSION
+qhp.QtWebBrowser.customFilters.QtWebBrowser.name = Qt WebBrowser $QT_VERSION
+qhp.QtWebBrowser.customFilters.QtWebBrowser.filterAttributes = qtwebbrowser $QT_VERSION
qhp.QtWebBrowser.indexRoot =
qhp.QtWebBrowser.subprojects = manual
@@ -27,14 +21,16 @@ qhp.QtWebBrowser.subprojects.manual.indexTitle = Qt WebBrowser
qhp.QtWebBrowser.subprojects.manual.title = Qt WebBrowser
qhp.QtWebBrowser.subprojects.manual.type = manual
-indexes += $QT_INSTALL_DOCS/qtlocation/qtlocation.index \
- $QT_INSTALL_DOCS/qtquick/qtquick.index \
- $QT_INSTALL_DOCS/qtvirtualkeyboard/qtvirtualkeyboard.index \
- $QT_INSTALL_DOCS/qtwebengine/qtwebengine.index
+#indexes += $QT_INSTALL_DOCS/qtlocation/qtlocation.index \
+# $QT_INSTALL_DOCS/qtquick/qtquick.index \
+# $QT_INSTALL_DOCS/qtvirtualkeyboard/qtvirtualkeyboard.index \
+# $QT_INSTALL_DOCS/qtwebengine/qtwebengine.index
+
+depends += qtquick qtlocation qtwebengine qtvirtualkeyboard
# Doxygen compatibility commands
macro.see = "\\sa"
macro.function = "\\fn"
navigation.homepage = "Qt WebBrowser Manual"
-buildversion = "Qt WebBrowser $QTWEBBROWSER_VERSION"
+buildversion = "Qt WebBrowser $QT_VERSION"
diff --git a/doc/qtwebbrowser.qdocconf b/doc/qtwebbrowser.qdocconf
index 2379b46..383d83a 100644
--- a/doc/qtwebbrowser.qdocconf
+++ b/doc/qtwebbrowser.qdocconf
@@ -1,2 +1,2 @@
-include(config/qtwebbrowser-project.qdocconf)
-include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
+include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf)
+include(qtwebbrowser-project.qdocconf)
diff --git a/qtwebbrowser.pro b/qtwebbrowser.pro
index 2bce66e..619a237 100644
--- a/qtwebbrowser.pro
+++ b/qtwebbrowser.pro
@@ -1,9 +1,8 @@
TEMPLATE = subdirs
-SUBDIRS = src
-requires(qtHaveModule(webengine))
+SUBDIRS = \
+ doc \
+ src
-QTWEBBROWSER_VERSION = 1.0.0
-QTWEBBROWSER_VERSION_TAG = 100
+requires(qtHaveModule(webengine))
-include(doc/doc.pri)