diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2017-01-20 14:10:16 +0100 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2017-01-23 12:24:35 +0000 |
| commit | 3f76c27847c157a0292a4caf73617f7d1d86edef (patch) | |
| tree | f4e488b25a0115228a27e9fb7dccf99c71e658a8 /doc/doc_targets.pri | |
| parent | 6f7ad4f7efed8b41e6eb75bca3132a7ffdbff461 (diff) | |
Make the documentation includable by other projects (qmake build)
Other projects (e.g. Qt Creator) can now build and install the qbs
documentation by including doc_targets.pri and setting the variables
QBS_DOCS_INSTALL_DIR and QBS_DOCS_BUILD_DIR.
By overriding QBS_DOCS_INSTALL_DIR users can also specify an alternative
documentation installation location for qbs itself.
Task-number: QBS-856
Task-number: QTCREATORBUG-13124
Change-Id: Ie490977b041936228f60885f519de77da10de109
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc/doc_targets.pri')
| -rw-r--r-- | doc/doc_targets.pri | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/doc_targets.pri b/doc/doc_targets.pri new file mode 100644 index 000000000..79f485721 --- /dev/null +++ b/doc/doc_targets.pri @@ -0,0 +1,49 @@ +# This pri file can be included by other projects that want to provide the qbs documentation. +# Common variables like QDOC_BIN or HELPGENERATOR must be provided by the including file. +QBS_VERSION_TAG = $$replace(QBS_VERSION, "[-.]", ) + +isEmpty(QBS_DOCS_BUILD_DIR): QBS_DOCS_BUILD_DIR = $$OUT_PWD/doc +isEmpty(QBS_HTML_DOC_PATH): QBS_HTML_DOC_PATH = $$QBS_DOCS_BUILD_DIR/html +equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys + QDOC = SRCDIR=$$PWD OUTDIR=$$QBS_HTML_DOC_PATH QBS_VERSION=$$QBS_VERSION QBS_VERSION_TAG=$$QBS_VERSION_TAG QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS] $$QDOC_BIN +} else: mingw { + # The lack of spaces in front of the && is necessary! + QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$QBS_HTML_DOC_PATH&& set QBS_VERSION=$$QBS_VERSION&& set QBS_VERSION_TAG=$$QBS_VERSION_TAG&& set QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS]&& $$QDOC_BIN +} else { # nmake + QDOC = set SRCDIR=$$PWD $$escape_expand(\\n\\t) \ + set OUTDIR=$$QBS_HTML_DOC_PATH $$escape_expand(\\n\\t) \ + set QBS_VERSION=$$QBS_VERSION $$escape_expand(\\n\\t) \ + set QBS_VERSION_TAG=$$QBS_VERSION_TAG $$escape_expand(\\n\\t) \ + set QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS] $$escape_expand(\\n\\t) \ + $$QDOC_BIN +} + +QBS_QHP_FILE = $$QBS_HTML_DOC_PATH/qbs.qhp +QBS_QCH_FILE = $$QBS_DOCS_BUILD_DIR/qbs.qch + +QBS_HELP_DEP_FILES = \ + $$PWD/qbs.qdoc \ + $$PWD/qbs.qdocconf + +qbs_html_docs.commands = $$QDOC $$PWD/qbs.qdocconf +qbs_html_docs.depends += $$QBS_HELP_DEP_FILES + +qbs_qch_docs.commands = $$HELPGENERATOR -o $$shell_quote($$QBS_QCH_FILE) $$QBS_QHP_FILE +qbs_qch_docs.depends += qbs_html_docs + +isEmpty(QBS_DOCS_INSTALL_DIR): QBS_DOCS_INSTALL_DIR = $${QBS_INSTALL_PREFIX}/share/doc/qbs +inst_qbs_qch_docs.files = $$QBS_QCH_FILE +inst_qbs_qch_docs.path = $$QBS_DOCS_INSTALL_DIR +inst_qbs_qch_docs.CONFIG += no_check_exist no_default_install +INSTALLS += inst_qbs_qch_docs + +inst_qbs_html_docs.files = $$QBS_HTML_DOC_PATH +inst_qbs_html_docs.path = $$inst_qbs_qch_docs.path +inst_qbs_html_docs.CONFIG += no_check_exist no_default_install directory +INSTALLS += inst_qbs_html_docs + +qbs_install_docs.depends = install_inst_qbs_qch_docs install_inst_qbs_html_docs +QMAKE_EXTRA_TARGETS += qbs_install_docs + +qbs_docs.depends = qbs_qch_docs +QMAKE_EXTRA_TARGETS += qbs_html_docs qbs_qch_docs qbs_docs |