diff options
author | Kai Koehne <kai.koehne@qt.io> | 2019-08-06 12:03:04 +0200 |
---|---|---|
committer | Kai Koehne <kai.koehne@qt.io> | 2019-09-17 14:12:05 +0200 |
commit | 37e2fe2b4cc70a85c9cdaccdd94d2284864290ba (patch) | |
tree | e79c991affeef57940967ae83b833e67523fd6f9 | |
parent | 530a73a82518543e1432cf439dda5e0305e1224b (diff) |
CMake: Move documentation into separate project
We've now four pages, which logically belong together. So let's
move them into one 'qtcmake' module.
Change-Id: I3015fc0804d62bcaec2cfbb6b84c6c08fe5f43f8
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
-rw-r--r-- | doc/config/qtdoc.qdocconf | 6 | ||||
-rw-r--r-- | doc/src/cmake/cmake-manual.qdoc (renamed from doc/src/development/cmake-manual.qdoc) | 0 | ||||
-rw-r--r-- | doc/src/cmake/cmake.pro | 9 | ||||
-rw-r--r-- | doc/src/cmake/qtcmake.qdocconf | 39 | ||||
-rw-r--r-- | doc/src/cmake/snippets/cmake/examples.cmake (renamed from doc/src/snippets/cmake/examples.cmake) | 0 | ||||
-rw-r--r-- | qtdoc.pro | 8 |
6 files changed, 59 insertions, 3 deletions
diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf index 4883371a6..584b95ee3 100644 --- a/doc/config/qtdoc.qdocconf +++ b/doc/config/qtdoc.qdocconf @@ -11,6 +11,7 @@ moduleheader = depends += \ activeqt \ + qtcmake \ qdoc \ qmake \ qtandroidextras \ @@ -85,9 +86,10 @@ exampledirs += \ ../snippets \ ../../examples -# Don't parse files in snippets directory +# Don't parse files in snippets and cmake directories excludedirs += \ - ../src/snippets + ../src/snippets \ + ../src/cmake examplesinstallpath = diff --git a/doc/src/development/cmake-manual.qdoc b/doc/src/cmake/cmake-manual.qdoc index ebd18593a..ebd18593a 100644 --- a/doc/src/development/cmake-manual.qdoc +++ b/doc/src/cmake/cmake-manual.qdoc diff --git a/doc/src/cmake/cmake.pro b/doc/src/cmake/cmake.pro new file mode 100644 index 000000000..3fd95bd29 --- /dev/null +++ b/doc/src/cmake/cmake.pro @@ -0,0 +1,9 @@ +TEMPLATE = aux + +QMAKE_DOCS = $$PWD/qtcmake.qdocconf + +QTDIR = $$[QT_HOST_PREFIX] +exists($$QTDIR/.qmake.cache): \ + QMAKE_DOCS_OUTPUTDIR = $$QTDIR/doc/cmake +else: \ + QMAKE_DOCS_OUTPUTDIR = $$OUT_PWD/cmake diff --git a/doc/src/cmake/qtcmake.qdocconf b/doc/src/cmake/qtcmake.qdocconf new file mode 100644 index 000000000..a2b36ba1c --- /dev/null +++ b/doc/src/cmake/qtcmake.qdocconf @@ -0,0 +1,39 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/global/externalsites.qdocconf) + +project = QtCMake +description = Using Qt with CMake +version = $QT_VERSION + +qhp.projects = qtcmake + +qhp.qtcmake.file = qtcmake.qhp +qhp.qtcmake.namespace = org.qt-project.qtcmake.$QT_VERSION_TAG +qhp.qtcmake.virtualFolder = qtcmake +qhp.qtcmake.indexTitle = Using Qt with CMake +qhp.qtcmake.filterAttributes = qt $QT_VERSION tools cmake +qhp.qtcmake.customFilters.qtcmake.name = Build with CMake +qhp.qtcmake.customFilters.qtcmake.filterAttributes = qt tools cmake +qhp.qtcmake.subprojects = manual +qhp.qtcmake.subprojects.manual.title = Manual +qhp.qtcmake.subprojects.manual.indexTitle = Build with CMake +qhp.qtcmake.subprojects.manual.selectors = fake:page + +sources = cmake-manual.qdoc + +exampledirs = . + +# Instruct Clang not to look for a module header +moduleheader = + +depends += \ + qtdoc \ + qtcore \ + qtnetwork \ + qtsql \ + qtgui \ + qtwidgets \ + qtdbus \ + qtlinguist + +navigation.landingpage = "Build with CMake" diff --git a/doc/src/snippets/cmake/examples.cmake b/doc/src/cmake/snippets/cmake/examples.cmake index 264f3c05d..264f3c05d 100644 --- a/doc/src/snippets/cmake/examples.cmake +++ b/doc/src/cmake/snippets/cmake/examples.cmake @@ -1,3 +1,9 @@ load(qt_parts) -SUBDIRS += doc +cmake.file = doc/src/cmake/cmake.pro + +doc.file = doc/doc.pro +doc.depends = cmake + +SUBDIRS += doc cmake + |