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

72 lines
2.3 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
Doc: Set an empty module header for QtDoc Clang tries to find a module header <QtDoc> for this project and warns about it. Use an empty 'moduleheader' variable to clear the warning. Change-Id: Iee7ae73339f5e345c25d2e9ded0050378b476356 Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-03-27 11:01:56 +00:00
# Instruct Clang not to look for a module header
moduleheader =
doc: Make QtDoc depend on all modules This update sets the depends variable in qtdoc.qdocconf to '*'. Change-Id: Ib202a7a9aa1a3990a303cfe5d19a158d1ecc1b6b Task-number: QTBUG-77126 Reviewed-by: Martin Smith <martin.smith@qt.io>
2019-10-22 07:46:02 +00:00
# Depend on everything - load all available index files
depends = *
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: Move coffeemachine examples to examples/demos -Also add license file for TitilliumWeb-Regular.ttf -Add qt_qttribution.json and LICENSE.txt Task-number: QTBUG-68357 Change-Id: I705a28ed9f113e7ad3cca1b93eb162cc223d9d2d Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2018-05-22 12:01:05 +00:00
../snippets \
Move demos to qtdoc repository These demos use several modules and moving them allows to use for example Qt Quick Controls 2 in them. The shared directory should be removed and the examples made self-contained. Change-Id: I5dc667d22388651894d7d145b65752bc5c5cf6cf Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
2018-06-26 13:53:07 +00:00
../../examples
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
excludedirs += \
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>
2019-08-06 10:03:04 +00:00
../src/snippets \
First steps towards documenting our platform APIs Adds a new top level topic for platform integration, moving the QPA docs under that, and cleans up and rewrites the QPA docs for Qt 6. Task-number: QTBUG-80233 Change-Id: I658e5e2c402a25ce391102675cee6ada0563e71f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-10-02 12:35:10 +00:00
../src/cmake \
../src/platformintegration
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
Doc: tutorial Get Started with Qt Quick Task-number: QTBUG-68739 Change-Id: Ib14e4eb4c20583af2be9198539077f1be5ae471a Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2018-08-03 12:21:05 +00:00
examplesinstallpath =
Doc: Move coffeemachine examples to examples/demos -Also add license file for TitilliumWeb-Regular.ttf -Add qt_qttribution.json and LICENSE.txt Task-number: QTBUG-68357 Change-Id: I705a28ed9f113e7ad3cca1b93eb162cc223d9d2d Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2018-05-22 12:01:05 +00:00
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.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
Doc: Use a macro for generating the index page title Define a macro for generating the index page title with the correct Qt version (major.minor). This way, the version is automatically updated on the landing page, based on .qmake.conf. Change-Id: I44fcc76bfe4ac899a4d3edb334892b088e021d56 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2016-04-01 08:15:33 +00:00
macro.indextitle = "\\title Qt $QT_VER"
Doc: Update supported platforms for Qt 5.9 - Drop macOS 10.9, iOS 7, WinRT 8.1, Windows Phone 8.1 - Add MSVC 2017 for Windows configurations Also clarify the latest Qt version on the top-level supported platforms page. Change-Id: Ia5b193c8cfbed67ec50e4951d6f474b6b19f4e8e Reviewed-by: Jake Petroules <jake.petroules@qt.io>
2017-04-04 11:24:13 +00:00
macro.qtver = "$QT_VER"
Doc: Add link to the YouTube video about installing Qt Change-Id: Ifb3920d5af764fd77644c32628223f5b5deb214f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-08-31 12:51:31 +00:00
# Config to enable YouTube links in the offline documentation
HTML.extraimages += ../images/I5jasWrsxT0.jpg
qhp.QtDoc.extraFiles += ../images/I5jasWrsxT0.jpg