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

105 lines
3.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: Set example root URL in documentation configuration This sets 'url.examples' that is used for generating the link to the example project under code.qt.io in example documentation. Pick-to: 6.5 6.4 Change-Id: I5f7647d38b622503c3b1e1d568d64762ef4c55bf Reviewed-by: Vladimir Minenko <vladimir.minenko@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-01-12 20:48:40 +00:00
include($QT_INSTALL_DOCS/config/exampleurl-qtdoc.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: Fix qdoc warnings Change-Id: I10434c5231794ce91ddb170882ce8e55ca829cd0 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-11 20:54:56 +00:00
# include java files in the list of example sources
examples.fileextensions =+ *.java
Doc: Exclude docs for broken examples This should avoid unnecessary attention to these examples, at least till they are fixed. Change-Id: Iffbbfa06c56c9cf66e9b70a632ced175206ac78a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-19 10:17:31 +00:00
# Exclude documentation for the broken examples
excludefiles += \
../../examples/demos/maroon/doc/src/maroon.qdoc \
../../examples/demos/samegame/doc/src/samegame.qdoc \
Update examples to use XmlListModel from QtDeclarative Now when the XmlListModel is a part of QtDeclarative, we can udpate the examples, which were using the model. This patch introduces the following changes: - Uses XmlListModel from QtDeclarative, removes the custom implementation from shared subdir. - Improves photoviewer and rssnew examples to get rid of some qml and C++ warnings and deprecation notifications. - Updates the documentation for photoviewer and rssnew examples to reflect the usage of the XmlListModel from QtDeclarative. - Enables documentation build for rssnews example Task-number: QTBUG-89817 Change-Id: If3736a18070dc19492058f7c184d5c9cfab74663 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2021-02-24 16:56:35 +00:00
../../examples/demos/tweetsearch/doc/src/tweetsearch.qdoc
Doc: Exclude docs for broken examples This should avoid unnecessary attention to these examples, at least till they are fixed. Change-Id: Iffbbfa06c56c9cf66e9b70a632ced175206ac78a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-19 10:17:31 +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.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
Fix path for YouTube video thumbnail A relative path was used to refer to a thumbnail image for a video link on Qt for Android overview page. While QDoc was able to locate and copy the image to the output directory, the relative path appears as-is in the generated .qhp file and is no longer correct, causing qhelpgenerator to ignore it. Consolidate all 'extra images' into the same source directory and handle them in one location in the .qdocconf file. Pick-to: 6.4 Change-Id: I66531da883bac57fcf32e75c11eb087a648d9798 Reviewed-by: Luca Di Sera <luca.disera@qt.io>
2022-10-12 08:18:06 +00:00
# Add an image used in example manifests to qhp, as well as thumbnails for YouTube links
Adapt qdoc macros for DocBook Change-Id: I96ae4df88465eeecd40d8c32dae2a9302fda1bfc Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2022-07-10 23:40:31 +00:00
{HTML.extraimages,DocBook.extraimages,qhp.QtDoc.extraFiles} += images/qt-codesample.png \
images/yIv0vO8B7tQ.jpg \
Docs: Add Android platform documentation How it works page, host environment variables page, and relevant CMake information page added. Fixes: QTBUG-107704 Pick-to: 6.4 6.2 Change-Id: I823d3f9d97f49e79da867660bd4cd41a8378266a Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-10-31 12:30:20 +00:00
images/5OiIqFTjUZI.jpg \
Doc: Consolidate internationalization documentation - Combine the "Internationalization with Qt" and "Internationalization and Localization with Qt Quick" topics - Add a "Localizing Applications" topic - Move information from the Qt Linguist Manual developer section to the new topics - Add a link to a YouTube video about localizing apps - Use active voice and present tense Fixes: QTBUG-71876 Change-Id: If2db1d4865e47a85e0b63adac326fc123ad65e50 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2023-01-24 08:43:17 +00:00
images/nmvurCcsWos.jpg \
images/xNIz78IPBu0.jpg
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"
Add documentation for qt6.conf Task-number: QTBUG-88635 Change-Id: Iffd93a0654daa3b26d354340445825ab87fd8ad1 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-01-01 02:01:00 +00:00
macro.qtmajorversion = "$QT_VER"
macro.qtmajorversion.match = "^(\\d+)"
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
Add Extras modules porting guide Pick-to: 6.2 Task-number: QTBUG-83251 Task-number: QTBUG-84382 Task-number: QTBUG-89564 Task-number: QTBUG-93629 Task-number: QTBUG-93633 Change-Id: I3b56cb19459814a0ebfd00195a9856fb742d1288 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2021-07-15 12:13:20 +00:00
macro.qt5 = "\\l{https://doc.qt.io/qt-5/\1}{\2}"
macro.qtbug = "\\l{https://bugreports.qt.io/browse/\1}{\1}"
Highlight Coffee Machine Example in Qt Creator Change-Id: I88a9a53d17456446f908b4a0832bb1fb7ef0ed9a Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2020-11-18 12:34:10 +00:00
manifestmeta.highlighted.names = "QtDoc/Coffee Machine Example" \
Highlight calqlatr example in creator Adding the calqlatr as a highlighted example in the qt creator welcome page. Pick-to: 6.2 Change-Id: Ib87d0f731d2922d1f5c697479a2a4f936d9a836f Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2021-09-14 10:04:49 +00:00
"QtDoc/Qt Quick Demo - Same Game" \
"QtDoc/Qt Quick Demo - Calqlatr"
Add manual tags to coffeemachine example Pick-to: 6.0 Change-Id: I0b288bb3b3f23986b2af394062b3a9d470e7faf5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-12-03 17:19:28 +00:00
Add full list of example categories to examples metadata Add the full list of all example categories in the right order to QtDoc metadata. This will generate a matching list in the matching examples-manifest.xml file, and allows Qt Creator to sort the categories correctly. Pick-to: 6.5 6.6 Change-Id: I45dccf4d7fd0020e25f19e22a5bfebb44f640cca Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-21 10:05:49 +00:00
manifestmeta.examplecategories = "Application Examples" \
"Desktop" \
"Mobile" \
"Embedded" \
"Graphics & Multimedia" \
"Data Visualization & 3D" \
"Data Processing & I/O" \
"Connectivity" \
"Networking" \
"Positioning & Location" \
Add 'User Interface Components' example category Pick-to: 6.5 6.6 Task-number: QTBUG-115174 Change-Id: Ia9b6214bf82146ad5b6c485379c2abc6fe2c4c1c Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Tuukka Turunen <tuukka.turunen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-08-31 12:29:24 +00:00
"User Interface Components" \
Add full list of example categories to examples metadata Add the full list of all example categories in the right order to QtDoc metadata. This will generate a matching list in the matching examples-manifest.xml file, and allows Qt Creator to sort the categories correctly. Pick-to: 6.5 6.6 Change-Id: I45dccf4d7fd0020e25f19e22a5bfebb44f640cca Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-07-21 10:05:49 +00:00
"Web Technologies"
Doc: Add documentation for Qt educational license Add step-by-step install instructions for installing Qt for application development and Qt Design Studio for Qt educational license holders. These steps differ from normal procedure with the online installer as it involves the creation of Qt Account via the education license program, and the available packages differ from those in the open-source edition. Add instructions for using Raspberry Pi as a target hardware via QBSP, also available as part of the educational license. Link to the new pages from Getting Started, and add information about the educational license to Licensing page. Pick-to: 6.4 Fixes: QTBUG-106537 Done-with: Hanna Humaljoki <hanna.humaljoki@qt.io> Change-Id: Icce481c50f19580363e25e07b084bc80d7e1132a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-10-07 21:09:53 +00:00
# Include 'Qt for Education' pages
include(../edu/config/qtforeducation.qdocconf)
Doc: Fix ill-placed */ in WebAssembly documentation The closing C-style comment delimiter causes the entire documentation block to terminate early. In passing, fix some formatting issues, converting documented steps to an ordered \list. Mark the qtdoc module clear of documentation warnings. Pick-to: 6.6 Change-Id: I55973e5ed84038fcd7a164e091c112f929af32be Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-08-30 12:19:02 +00:00
# Enforce zero documentation warnings
warninglimit = 0