qt-creator/doc/doc.pri

QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)
HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)

equals(QMAKE_DIR_SEP, /) {   # unix, mingw+msys
    QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html $$QDOC_BIN
} else:win32-g++* {   # just mingw
    # The lack of spaces in front of the && is necessary!
    QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& $$QDOC_BIN
} else {   # nmake
    QDOC = set SRCDIR=$$PWD $$escape_expand(\n\t) \
           set OUTDIR=$$OUT_PWD/doc/html $$escape_expand(\n\t) \
           $$QDOC_BIN
}

QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp
QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch

html_docs.commands = $$QDOC $$PWD/qtcreator.qdocconf
html_docs.depends += $$PWD/qtcreator.qdoc $$PWD/qtcreator.qdocconf
html_docs.files = $$QHP_FILE

qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE
qch_docs.depends += html_docs
qch_docs.files = $$QCH_FILE

unix:!macx {
    qch_docs.path = /share/doc/qtcreator
    qch_docs.CONFIG += no_check_exist
    INSTALLS += qch_docs
}

docs.depends = qch_docs
QMAKE_EXTRA_TARGETS += html_docs qch_docs docs

OTHER_FILES = $$PWD/qtcreator.qdoc \
              $$PWD/qtcreator.qdocconf
OTHER_FILES += $$PWD/api/qtcreator-api.qdoc \
               $$PWD/api/qtcreator-api.qdocconf
less bizarre build command setup for windows 2009-11-02 21:35:31 +01:00			`QDOC_BIN = $$targetPath($$[QT_INSTALL_BINS]/qdoc3)`
			`HELPGENERATOR = $$targetPath($$[QT_INSTALL_BINS]/qhelpgenerator)`
Find qmake in the right location for Qt 4.6+ 2009-08-21 12:52:54 +02:00
less bizarre build command setup for windows 2009-11-02 21:35:31 +01:00			`equals(QMAKE_DIR_SEP, /) { # unix, mingw+msys`
			`QDOC = SRCDIR=$$PWD OUTDIR=$$OUT_PWD/doc/html $$QDOC_BIN`
			`} else:win32-g++* { # just mingw`
			`# The lack of spaces in front of the && is necessary!`
Workaround bug where documentation sometimes is not generated. On Windows, for unknown reasons, qhelpgenerator.exe sometimes will not generate the documentation if run directly from nmake. Running it through an intermediate cmd seems to work. So, do that. Reviewed-by: Daniel Molkentin 2009-09-30 00:45:37 +10:00			`QDOC = set SRCDIR=$$PWD&& set OUTDIR=$$OUT_PWD/doc/html&& $$QDOC_BIN`
less bizarre build command setup for windows 2009-11-02 21:35:31 +01:00			`} else { # nmake`
			`QDOC = set SRCDIR=$$PWD $$escape_expand(\n\t) \`
			`set OUTDIR=$$OUT_PWD/doc/html $$escape_expand(\n\t) \`
			`$$QDOC_BIN`
Initial import 2008-12-02 12:01:29 +01:00			`}`

Fixes: - Mac build (docs) and toplevel "make docs" target RevBy: - bjørn 2009-01-07 15:47:25 +01:00			`QHP_FILE = $$OUT_PWD/doc/html/qtcreator.qhp`
macx: compile doc into the right directory instead of copying it later 2009-11-02 21:36:26 +01:00			`QCH_FILE = $$IDE_DOC_PATH/qtcreator.qch`
Initial import 2008-12-02 12:01:29 +01:00
Fixes: Regression for make docs on unix 2009-01-14 20:08:39 +01:00			`html_docs.commands = $$QDOC $$PWD/qtcreator.qdocconf`
Initial import 2008-12-02 12:01:29 +01:00			`html_docs.depends += $$PWD/qtcreator.qdoc $$PWD/qtcreator.qdocconf`
			`html_docs.files = $$QHP_FILE`

macx: compile doc into the right directory instead of copying it later 2009-11-02 21:36:26 +01:00			`qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE`
Initial import 2008-12-02 12:01:29 +01:00			`qch_docs.depends += html_docs`
			`qch_docs.files = $$QCH_FILE`

Fixes: Make qmake generate install target for docs 2009-03-13 10:31:30 +01:00			`unix:!macx {`
Fixes: make install workd Details: Make install works now, we just have to agree on layout details and check for mac compatibility. Also, plugins will carry no version in their filename anymore starting with this commit. Versioning happens in the creators pluginloader using the pluginspec file. 2009-01-20 14:58:10 +01:00			`qch_docs.path = /share/doc/qtcreator`
do not create invalid help files afaik, this was a bizarre hack to make the install target work, so fix it properly instead. 2009-11-02 21:01:49 +01:00			`qch_docs.CONFIG += no_check_exist`
Fixes: make install workd Details: Make install works now, we just have to agree on layout details and check for mac compatibility. Also, plugins will carry no version in their filename anymore starting with this commit. Versioning happens in the creators pluginloader using the pluginspec file. 2009-01-20 14:58:10 +01:00			`INSTALLS += qch_docs`
			`}`

macx: compile doc into the right directory instead of copying it later 2009-11-02 21:36:26 +01:00			`docs.depends = qch_docs`
			`QMAKE_EXTRA_TARGETS += html_docs qch_docs docs`
Initial import 2008-12-02 12:01:29 +01:00
Add the documentation files to doc.pri for easy access. 2009-10-01 12:31:54 +02:00			`OTHER_FILES = $$PWD/qtcreator.qdoc \`
			`$$PWD/qtcreator.qdocconf`
			`OTHER_FILES += $$PWD/api/qtcreator-api.qdoc \`
			`$$PWD/api/qtcreator-api.qdocconf`