qiurui
/
qtdoc
mirror of https://github.com/qt/qtdoc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qtdoc/doc/config/qtdoc.qdocconf

117 lines
2.9 KiB
Plaintext
Raw Normal View History

Make the qtdoc repo part of the modularized build The monolithic build is now partially removed, but there's still a lot of cruft left that we'll remove once we know what we need or not need. This introduces a bunch of qdoc warnings for examplee documentation that live in the qdoc repo, but that references an example that lives in the module. These example docs should be moved to the corresponding module. Change-Id: I15f9f9087f1e96786ce2a49a7192f1015cb192db Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
2012-10-15 17:47:45 +00:00
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
Doc: Include the external site information Explicitly include the external site URLs from the global Qt documentation config, as they're no longer included by default. Task-number: QTBUG-41003 Change-Id: I622b1338ad5133ec68473098733c9a12cc587e24 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2014-09-01 08:41:45 +00:00
include($QT_INSTALL_DOCS/global/externalsites.qdocconf)
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
project = QtDoc
description = Qt Reference Documentation
version = $QT_VERSION
depends += \
activeqt \
Doc: Update dependencies in documentation config - Remove dependency to qtmultimediawidgets (qtmultimedia includes now also Qt Multimedia Widgets documentation) - Add qdoc (QDoc Manual) Change-Id: I45a34fbbb20f1fb0e02e456387a93af58b8106e7 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2016-01-14 11:43:14 +00:00
qdoc \
Doc: Fixed qdocconf merge issue -qtdoc-project.qdocconf was removed in d4359e but git brought it back during a merge. -Added 'qmake' in the depends because the merge didn't merge the change to the new file. Change-Id: Iddcce47186c09d1799ed236878b72455ac62c3fe Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-09-11 13:45:58 +00:00
qmake \
Doc: Adding qtmacextras and qtandroidextras to the depends variable. Needed to link to qtmacextras and qtandroidextras documentation. Change-Id: I165036b0e2108b26084193a6421692bcebc28db5 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
2013-10-15 13:43:50 +00:00
qtandroidextras \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtassistant \
qtbluetooth \
qtconcurrent \
qtcore \
qtdbus \
qtdesigner \
Doc: Enabling cross-linking to the Enginio Manual. Change-Id: Ifbbce3f4210c327e053ddc236250e5f7985b32bf Reviewed-by: Sergio Ahumada <sahumada@blackberry.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-03-28 15:19:41 +00:00
qtenginio \
Doc: Various fixes to Enginio related links. -Added the other Enginio depends variables. -Updated name of Enginio. Task-number: QTBUG-33360 Change-Id: Ica6f7f7ba89740ac610d27e839ae08fed81ada6a Reviewed-by: Sergio Ahumada <sahumada@blackberry.com>
2014-04-15 12:01:27 +00:00
qtenginiooverview \
qtenginioqml \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtgraphicaleffects \
qthelp \
qtimageformats \
qtgui \
qtlinguist \
Hook Qt Location into the general Qt documentation Change-Id: I09f0fefa23cb93fd35e799f2bae3b9ecafa10597 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-02-18 10:50:15 +00:00
qtlocation \
Doc: Adding qtmacextras and qtandroidextras to the depends variable. Needed to link to qtmacextras and qtandroidextras documentation. Change-Id: I165036b0e2108b26084193a6421692bcebc28db5 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
2013-10-15 13:43:50 +00:00
qtmacextras \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtmultimedia \
qtnetwork \
qtnfc \
qtopengl \
Doc: Add Qt Platform Headers to All Modules page. And and a dependency to it, allowing the module's classes to be shown on the 'All C++ Classes' page. Change-Id: Ib1d570f3e268860cd933b6b164f59231a0b77775 Reviewed-by: Laszlo Agocs <laszlo.agocs@digia.com>
2014-08-21 10:04:09 +00:00
qtplatformheaders \
Add Qt Positioning module links to core doc pages Change-Id: I9ecb98175640f494ec0be9f9cbf2492ace5d9719 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-16 12:26:33 +00:00
qtpositioning \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtprintsupport \
qtqml \
qtquick \
qtquickcontrols \
qtquickdialogs \
Doc: Update Qt Modules page and related information - Mark Qt WebKit, Qt Script, Qt Declarative as deprecated - Add Qt Quick Extras, remove Qt Quick Enterprise Controls - Graduate Qt Canvas 3D from technology preview to an Add-on module - Add Qt3D as a Technology Preview module - Add Qt Quick Widgets (was missing previously) Task-number: QTBUG-44680 Change-Id: I91c70c533f70a4478adc5e488af469864611d7c8 Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-05-13 10:00:29 +00:00
qtquickextras \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtquicklayouts \
qtscript \
qtscripttools \
Add Qt SCXML to the list of TP modules Change-Id: Ia7b6148d6ed48821a0a59ec1d9b6fce981cf244c Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2016-02-25 13:25:26 +00:00
qtscxml \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtsensors \
Added Qt Serial Bus to the list of technology preview modules Change-Id: I76b1c0622298fc3b422804c27ef9e81e4c8b6054 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-07-09 08:49:22 +00:00
qtserialbus \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtserialport \
qtsql \
qtsvg \
qttestlib \
Doc: corrected broken links Task-number: QTBUG-34749 Change-Id: I14d0d04a0f6c1a02fe3ada4b61823f68c81a6985 Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-03-27 14:58:20 +00:00
qttools \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtuitools \
Doc: Enabled linking to Qt WebChannel. Added the project to the depends variable and added it to the list of modules. Change-Id: I80ad2bada0bf28489c080cbc5a373103646c3b5e Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
2014-08-17 15:53:17 +00:00
qtwebchannel \
Doc: Add Qt WebEngine to the module and example lists This module is new in Qt 5.4. Change-Id: I00a52b6268eadacbc49102c84c7773b660b59fdb Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-09-14 03:50:21 +00:00
qtwebengine \
Doc: Add Qt WebEngine Widgets to the .qdocconf Licensing documentation needs to link to a topic under the Qt WebEngine Widgets module. Change-Id: Ic6f9150fce02fdb2efda5d18b2a90fc387f866bd Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-10-06 10:05:08 +00:00
qtwebenginewidgets \
Doc: Add Qt WebEngine Core to Qt modules Link from Qt Modules page and What's New page. Also link to the license information in this new module as it applies to both Qt WebEngine and Qt WebEngine Widgets. Change-Id: Ib651edefff455a27531d33ac187a4f9ba349e583 Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com>
2015-07-29 09:37:35 +00:00
qtwebenginecore \
Add Qt WebSockets to add-ons and connectivity documentation Change-Id: I1d09e8533a07a2776b5a9a6279e5f50d6995184f Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-08 20:42:19 +00:00
qtwebsockets \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtwidgets \
Doc: Various documentation improvements to the All Modules page. -fixed missing links to Qt Windows Extras -created links to the appropriate platforms -replaced the \sa with the "Where to Go from Here" section -marked-up the terms "Qt Tools" and "Qt Add-Ons" as they are official Qt product names Change-Id: I0c5d314e3e2bc0ecdb4800855a65014debde3183 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-09-11 12:56:45 +00:00
qtwinextras \
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qtwebkit \
qtwebkitexamples \
qtx11extras \
qtxml \
Doc: Update Qt Modules page and related information - Mark Qt WebKit, Qt Script, Qt Declarative as deprecated - Add Qt Quick Extras, remove Qt Quick Enterprise Controls - Graduate Qt Canvas 3D from technology preview to an Add-on module - Add Qt3D as a Technology Preview module - Add Qt Quick Widgets (was missing previously) Task-number: QTBUG-44680 Change-Id: I91c70c533f70a4478adc5e488af469864611d7c8 Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-05-13 10:00:29 +00:00
qtxmlpatterns \
Doc: Fix broken link to the Qt 3D module page Qt 3D now uses a single documentation project that covers all its submodules. So it is not required to list the submodule name as a depends in the qdocconf. Change-Id: If907fb3e58f5b717d4e14ccce7789c6a4a0c2ccf Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-10-29 12:44:41 +00:00
qt3d \
Doc: Add a number of new doc modules into 'depends' Change-Id: I852b8e978401a2ea0c3642c6fea7d194fded2a32 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-09-23 09:09:02 +00:00
qtcanvas3d \
qtwebview \
Replace 'Qt Labs Controls' with 'Qt Quick Controls 2' Change-Id: I61882842015151741e700b1209dedcede7bde6f7 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-03-29 13:17:38 +00:00
qtquickcontrols2
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
headerdirs += ../src
imagedirs += ../src/images \
../images
sourcedirs += \
Doc: Remove superfluous example The files of the 'texteditor' example under the /examples are not referred to in the tutorial documentation that originally introduced it, nor is any example documentation generated for it. Remove the example as it ends up being copied into binary packages, which is not intended. This commit partially reverts 5cd576ea736d94cf0c95d4325d6367873ad338df. Change-Id: Iff121f6f0a55c5b47cd6420559e184f599db3a3e Task-number: QTBUG-48501 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-09-30 10:00:20 +00:00
../src
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
exampledirs += \
../src \
Doc: Remove superfluous example The files of the 'texteditor' example under the /examples are not referred to in the tutorial documentation that originally introduced it, nor is any example documentation generated for it. Remove the example as it ends up being copied into binary packages, which is not intended. This commit partially reverts 5cd576ea736d94cf0c95d4325d6367873ad338df. Change-Id: Iff121f6f0a55c5b47cd6420559e184f599db3a3e Task-number: QTBUG-48501 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-09-30 10:00:20 +00:00
../snippets
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
# Don't parse files in snippets directory
excludedirs += \
../src/snippets
qhp.projects = QtDoc
qhp.QtDoc.file = qtdoc.qhp
qhp.QtDoc.namespace = org.qt-project.qtdoc.$QT_VERSION_TAG
qhp.QtDoc.virtualFolder = qtdoc
qhp.QtDoc.indexTitle = Qt $QT_VERSION Reference Documentation
qhp.QtDoc.indexRoot =
qhp.QtDoc.filterAttributes = qtdoc $QT_VERSION qtrefdoc
Doc: Fix filter used for Assistant Use bookcase for the Qt Doc documentation filter, like the rest of the modules do. Change-Id: I7b988d6395f1f3020d2a2cd2fac02052d29df471 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-31 08:54:56 +00:00
qhp.QtDoc.customFilters.Qt.name = QtDoc $QT_VERSION
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qhp.QtDoc.customFilters.Qt.filterAttributes = qtdoc $QT_VERSION
qhp.QtDoc.subprojects = classes qmltypes examples
qhp.QtDoc.subprojects.classes.title = Classes
qhp.QtDoc.subprojects.classes.indexTitle = All Classes
Doc: Added selectors for the subprojects defined QDoc adds all the available nodes to the tree if there are no selectors for the subproject. This change avoids that and lists only the subproject title page entries under the main project in assistant, as there are no matching entries based on the chosen selectors. Change-Id: I282370d289fa4084ee1f383fe00dcd57da9e2f3e Task-number: QTBUG-43074 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-27 14:45:32 +00:00
qhp.QtDoc.subprojects.classes.selectors = class fake:headerfile
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qhp.QtDoc.subprojects.classes.sortPages = true
qhp.QtDoc.subprojects.qmltypes.title = QML Types
Doc: Fixed issues related to qhp in the .qdocconf file - Removed unneeded selectors for Classes, QML Types and Examples - Changed index title to point to All QML Types instead of All QML APIs by Module Change-Id: I03a211e9d45e6ee3a5d23cec260f9191518dd350 Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-10-02 12:58:37 +00:00
qhp.QtDoc.subprojects.qmltypes.indexTitle = All QML Types
Doc: Added selectors for the subprojects defined QDoc adds all the available nodes to the tree if there are no selectors for the subproject. This change avoids that and lists only the subproject title page entries under the main project in assistant, as there are no matching entries based on the chosen selectors. Change-Id: I282370d289fa4084ee1f383fe00dcd57da9e2f3e Task-number: QTBUG-43074 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-27 14:45:32 +00:00
qhp.QtDoc.subprojects.qmltypes.selectors = qmlclass
Doc: Removed unnecessary files -nothing in qtdoc repository uses them -images, CSS, .qdocconf, and other files Change-Id: I23a947a3731937ff604debded29535472881e14b Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-09 13:05:09 +00:00
qhp.QtDoc.subprojects.qmltypes.sortPages = true
qhp.QtDoc.subprojects.examples.title = Tutorials and Examples
qhp.QtDoc.subprojects.examples.indexTitle = Qt Examples And Tutorials
Doc: Added selectors for the subprojects defined QDoc adds all the available nodes to the tree if there are no selectors for the subproject. This change avoids that and lists only the subproject title page entries under the main project in assistant, as there are no matching entries based on the chosen selectors. Change-Id: I282370d289fa4084ee1f383fe00dcd57da9e2f3e Task-number: QTBUG-43074 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-27 14:45:32 +00:00
qhp.QtDoc.subprojects.examples.selectors = fake:example
Doc: Fixed issues related to qhp in the .qdocconf file - Removed unneeded selectors for Classes, QML Types and Examples - Changed index title to point to All QML Types instead of All QML APIs by Module Change-Id: I03a211e9d45e6ee3a5d23cec260f9191518dd350 Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-10-02 12:58:37 +00:00
qhp.QtDoc.subprojects.examples.sortPages = true
Doc: Add generic code sample image to qhp Changes from fff32616 to qtdoc-qhp.qdocconf were lost during merge as that file was deleted in the target branch. Add the changes to qtdoc.qdocconf instead. Change-Id: If59670d43ecab31ba1912f4ffe50266417374714 Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-19 14:03:31 +00:00
# Add an image used in example manifests to qhp
HTML.extraimages += images/qt-codesample.png
qhp.QtDoc.extraFiles += images/qt-codesample.png
Doc: Add sidebar content used in the qt.io online template As part of the new online style, each page has a sidebar with links to common topics - the same content as on the Qt reference documentation (index) page. Switch the order of the topics on the sidebar, based on Google Analytics feedback. Most-used links are from the 'Reference' category, so raise that one to the top. This commit adds the raw .html file into /style, which is then loaded dynamically by the template code. Task-number: QTBUG-42086 Change-Id: I69add8ca75c00bb1ff7039adf34194c2c673885d Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-10-21 10:45:31 +00:00
# Add an .html file with sidebar content, used in the online style
HTML.stylesheets += style/qt5-sidebar.html