From 33fa4b401c8e4f49cbee3bd31c7c21ade37faf6d Mon Sep 17 00:00:00 2001 From: Eike Ziller Date: Thu, 2 Mar 2017 15:55:08 +0100 Subject: Create a reusable docs.pri for generating documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Since we cannot directly use qt_docs.prf since it contains various Qt specific details, adapt it for use in Qt Creator. This can then be used e.g. by plugins that are not part of the Qt Creator repository. Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9 Reviewed-by: Topi Reiniö Reviewed-by: Oswald Buddenhagen --- doc/doc.pri | 88 ++++--------------------------------------------------------- 1 file changed, 5 insertions(+), 83 deletions(-) (limited to 'doc/doc.pri') diff --git a/doc/doc.pri b/doc/doc.pri index d6357ae311..1364a1a538 100644 --- a/doc/doc.pri +++ b/doc/doc.pri @@ -1,87 +1,9 @@ -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 = +build_online_docs: \ + QTC_DOCS = $$PWD/qtcreator-online.qdocconf $$PWD/api/qtcreator-dev-online.qdocconf +else: \ + QTC_DOCS = $$PWD/qtcreator.qdocconf $$PWD/api/qtcreator-dev.qdocconf -VERSION_TAG = $$replace(QTCREATOR_VERSION, "[-.]", ) - -# 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(SRCDIR=$$PWD OUTDIR=$$1 QTC_VERSION=$$QTCREATOR_VERSION QTC_VERSION_TAG=$$VERSION_TAG $$QDOC_GLOBAL) $$QDOC_BIN") -} - -QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp -QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch - -HELP_DEP_FILES = $$PWD/src/qtcreator.qdoc \ - $$PWD/config/macros.qdocconf \ - $$PWD/config/qt-cpp-ignore.qdocconf \ - $$PWD/config/qt-defines.qdocconf - -html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator.qdocconf -html_docs.depends += $$HELP_DEP_FILES -html_docs.files = $$QHP_FILE - -html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtcreator-online.qdocconf -html_docs_online.depends += $$HELP_DEP_FILES - -qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE -qch_docs.depends += html_docs - -DEV_QHP_FILE = $$OUT_PWD/doc/html-dev/qtcreator-dev.qhp -DEV_QCH_FILE = $$IDE_DOC_PATH/qtcreator-dev.qch - -DEV_HELP_DEP_FILES = \ - $$PWD/api/qtcreator-api.qdoc \ - $$PWD/api/coding-style.qdoc \ - $$PWD/api/external-tool-spec.qdoc \ - $$PWD/api/qtcreator-dev.qdoc \ - $$PWD/api/qtcreator-dev-wizards.qdoc \ - $$PWD/api/creating-plugins.qdoc \ - $$PWD/api/getting-and-building.qdoc \ - $$PWD/api/first-plugin.qdoc \ - $$PWD/api/plugin-metadata.qdoc \ - $$PWD/api/plugin-lifecycle.qdoc \ - $$PWD/api/pluginmanager.qdoc \ - $$PWD/api/qtcreator-documentation.qdoc \ - $$PWD/api/qtcreator-ui-text.qdoc \ - $$PWD/api/qtcreator-dev.qdocconf - -dev_html_docs.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev.qdocconf -dev_html_docs.depends += $$DEV_HELP_DEP_FILES - -dev_html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html-dev) $$PWD/api/qtcreator-dev-online.qdocconf -dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES - -dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE -dev_qch_docs.depends += dev_html_docs - -inst_qch_docs.files = $$QCH_FILE -inst_qch_docs.path = $$INSTALL_DOC_PATH -inst_qch_docs.CONFIG += no_check_exist no_default_install -INSTALLS += inst_qch_docs - -inst_dev_qch_docs.files = $$DEV_QCH_FILE -inst_dev_qch_docs.path = $$INSTALL_DOC_PATH -inst_dev_qch_docs.CONFIG += no_check_exist no_default_install -INSTALLS += inst_dev_qch_docs - -install_docs.depends = install_inst_qch_docs install_inst_dev_qch_docs -QMAKE_EXTRA_TARGETS += install_docs - -docs_online.depends = html_docs_online dev_html_docs_online -docs.depends = qch_docs dev_qch_docs -QMAKE_EXTRA_TARGETS += html_docs dev_html_docs html_docs_online dev_html_docs_online qch_docs dev_qch_docs docs docs_online - -DISTFILES = $$HELP_DEP_FILES $$DEV_HELP_DEP_FILES +include(../docs.pri) fixnavi.commands = \ cd $$shell_path($$PWD) && \ -- cgit v1.2.3