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

140 lines
5.5 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
Add documentation for qtjennydemo Add documentation for qtjennydemo, includes one .qdoc file and a .png overview image of the application. Fixes: QTTA-341 Pick-to: 6.9 Change-Id: I026d76932744e7fc5c89d6c5954572483eb6a440 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2025-04-28 11:20:54 +00:00
examples.fileextensions =+ *.java \
*.kt \
*.gradle
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
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 += \
Doc: Remove tweetsearch example The documentation for the example was disabled since commit 012384be6ae (6.0), so the example was little used. It also requires a Twitter developer account, which costs at least 100$ / month (https://developer.twitter.com/en/docs/twitter-api). So probably not worth to keep the example. Change-Id: I75e4a67a5525d49e9857703d5932081d697a68a6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
2023-11-13 14:00:20 +00:00
../../examples/demos/maroon/doc/src/maroon.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 =
Docs: Improve the root tree structure This commit reorganizes the root tree structure. The new "Product Information" subtree includes subtrees about licensing, supported platforms, and releases. The subtree about building UIs with Quick is moved to overviews and will sunset in the nearest future. Its content will be moved to Qt Quick. The References subtree was moved to the topmost position because of two reasons: it keeps the existing doc usage workflow possible and the reference section does not feel suitable at the bottom of the curent root tree. It happens because after the main content of the root tree, the module subtrees are attached. It's strange to see common concepts and modules separated by API references. Task-number: QTBUG-133740 Pick-to: 6.9 Change-Id: I6e9aa0e6cb2cc4b07fed8d3bf5e146aee9b3df67 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2025-02-19 10:43:52 +00:00
qhp.QtDoc.subprojects = manual
Docs: Organize topics in the qtdoc project This commit organizes the articles, so they: - have a reasonable tree structure - can be navigated through the topic tree in the Qt Creator help viewer Task-number: QTBUG-126606 Change-Id: I548c9475cd731b0fb6d287712a6b27203d748fc8 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-08-15 09:18:56 +00:00
qhp.QtDoc.subprojects.manual.title = Qt $QT_VERSION Reference Documentation
qhp.QtDoc.subprojects.manual.indexTitle = All Topics
qhp.QtDoc.subprojects.manual.type = manual
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
Docs: Return Tutorials and examples back to the tree This commit returns the autogenerated subtree with examples back to the topic tree. It was missing by mistake. Change-Id: I4cb8dbc484cc69ba6cd4b0c12491e5d970989dcd Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-10-29 08:08:16 +00:00
qhp.QtDoc.subprojects.examples.title = Tutorials and Examples
qhp.QtDoc.subprojects.examples.indexTitle = Qt Examples And Tutorials
qhp.QtDoc.subprojects.examples.selectors = example
qhp.QtDoc.subprojects.examples.sortPages = true
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 \
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 \
Docs: Move Qt Tools for Android Studio docs to tool's source repo Documentation moved here: qt-labs/android-studio-tools Task-number: QTTA-72 Pick-to: 6.7 6.8 Change-Id: I6429dbebfc3a41989162cb0cc9985260b7f4a06f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-06-07 10:27:37 +00:00
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
Add an ability to use a dynamic js tree for documentation navigation This commit adds the tree_config.xml configuration file that defines a way to build a topic tree for the online documentation site, a.k.a. https://doc.qt.io/qt-6/. Task-number: QTBUG-131113 Pick-to: 6.9 Change-Id: I858019cd4c1d891adc37d974d6494dca6f78297b Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-11-12 13:13:50 +00:00
HTML.stylesheets += style/qt5-sidebar.html \
style/tree_config.xml
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+)"
Fix string '6.8.0' found in 6.9.0 sources Updated to 6.9.0 where applicable. Replaced some instances with version macro. Task-number: QTBUG-130833 Change-Id: Ia9b1b73d218fa6b3994f8ce6ab667b4a21ea2ac3 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-11-06 11:25:56 +00:00
macro.QtVersionTag = "$QT_VERSION_TAG"
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}"
Doc: Fix list of highlighted examples Highlight all 'Application Examples' for now. This avoids WebEngine examples to be shown too prominently (as they are highlighted, too). Pick-to: 6.5 6.6 6.6.0 Change-Id: Ica3075ef8e29bad6babafd0491e8c0d1e0bc1bc1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2023-08-21 10:33:33 +00:00
# Highlight all examples in "Application Examples" category, as they are
# often added also to other categories (and typically are highlighted there)
manifestmeta.highlighted.names = "QtDoc/Calqlatr" \
Doc: Highlight Car Configurator Application Example Pick-to: 6.7 Task-number: QTBUG-120287 Change-Id: If747777f13821191a80275cd6f76a2e91d778483 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-12-21 12:22:42 +00:00
"QtDoc/Car Configurator" \
Doc: Fix list of highlighted examples Highlight all 'Application Examples' for now. This avoids WebEngine examples to be shown too prominently (as they are highlighted, too). Pick-to: 6.5 6.6 6.6.0 Change-Id: Ica3075ef8e29bad6babafd0491e8c0d1e0bc1bc1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2023-08-21 10:33:33 +00:00
"QtDoc/Coffee Machine" \
"QtDoc/Dice" \
"QtDoc/Document Viewer" \
"QtDoc/FX & Material Showroom" \
Doc: Highlight Lightning Viewer Example Application Examples by definition should be highlighted. Pick-to: 6.7 Task-number: QTBUG-116750 Change-Id: Ie7aafa387d5ccdd02d7f4b8bed5d501152d97246 Reviewed-by: MohammadHossein Qanbari <mohammad.qanbari@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Lars Sutterud <lars.sutterud@qt.io>
2024-01-02 16:48:27 +00:00
"QtDoc/Lightning Viewer" \
Doc: drop 'example' from title of application examples There is no need to keep the example in the title, see also https://wiki.qt.io/Qt6/Example-Guideline . Pick-to: 6.7 Change-Id: If173285c2e0f0ef7d21a113e4e0713aef84511dc Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2024-01-02 17:21:29 +00:00
"QtDoc/Media Player" \
Doc: Fix list of highlighted examples Highlight all 'Application Examples' for now. This avoids WebEngine examples to be shown too prominently (as they are highlighted, too). Pick-to: 6.5 6.6 6.6.0 Change-Id: Ica3075ef8e29bad6babafd0491e8c0d1e0bc1bc1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2023-08-21 10:33:33 +00:00
"QtDoc/Photo Surface" \
Doc: drop 'example' from title of application examples There is no need to keep the example in the title, see also https://wiki.qt.io/Qt6/Example-Guideline . Pick-to: 6.7 Change-Id: If173285c2e0f0ef7d21a113e4e0713aef84511dc Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2024-01-02 17:21:29 +00:00
"QtDoc/Robot Arm" \
Doc: Fix list of highlighted examples Highlight all 'Application Examples' for now. This avoids WebEngine examples to be shown too prominently (as they are highlighted, too). Pick-to: 6.5 6.6 6.6.0 Change-Id: Ica3075ef8e29bad6babafd0491e8c0d1e0bc1bc1 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2023-08-21 10:33:33 +00:00
"QtDoc/Thermostat" \
Doc: drop 'example' from title of application examples There is no need to keep the example in the title, see also https://wiki.qt.io/Qt6/Example-Guideline . Pick-to: 6.7 Change-Id: If173285c2e0f0ef7d21a113e4e0713aef84511dc Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2024-01-02 17:21:29 +00:00
"QtDoc/To Do List" \
Improve StocQt example metadata Rename to just 'StocQt', as we don't talk about demos anymore. Also mark example as to be highlighted. Pick-to: 6.6 6.7 Change-Id: I2b88db8b505ea628702484eaf21e896c2097ed65 Reviewed-by: Sakaria Pouke <sakaria.pouke@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2024-01-31 16:02:25 +00:00
"QtDoc/Same Game" \
Add OSM Buildings To the Doc highlights Change-Id: I707ae2a2bf84604a403c1416d32229a811c94a3c Reviewed-by: Janne Koskinen <janne.p.koskinen@qt.io>
2024-01-30 08:43:00 +00:00
"QtDoc/StocQt" \
"QtDoc/OSM Buildings"
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" \
Update examplecategories list Amends d741f3d9cb0aa540 Pick-to: 6.6 6.7 Task-number: QTBUG-117884 Change-Id: Ie25c08f5af1652ca054e2f16edc9da97ede79e97 Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
2024-01-16 16:03:56 +00:00
"Graphics" \
"Multimedia" \
Doc: Split up 'Data Visualization & 3D' category There's a lot of examples in the category; split it to separate 'Data Visualization' and '3D' categories. Pick-to: 6.7 Task-number: QTBUG-122377 Change-Id: I9026ada9d8eda72cae0cbfa8e5066438bb12661a Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-02-20 10:42:11 +00:00
"3D" \
"Data Visualization" \
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
"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
Doc: All overviews list categorization The \generate list names are added for each categorized section with some explanation. Here, calling the overviews as explanations-(name of the section). The idea is to give general terms instead of specific phrases like 'core' etc, for better understanding. Allow two warnings for \generatelist commands as the related \group pages live in modules external to qtdoc and are not loaded when testing documentation in the CI. Task-number: QTBUG-115347 Pick-to: 6.5 6.6 Change-Id: Ia8307d42fdb137808ae75cb9bcfeb58de30ba550 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2023-07-25 16:35:04 +00:00
# doc/src/overviews.qdoc:
# (qdoc) warning: '\generatelist explanations-webtechnologies' no such group
# (qdoc) warning: '\generatelist explanations-positioning' no such group
warninglimit = 2
Docs: Organize topics in the qtdoc project This commit organizes the articles, so they: - have a reasonable tree structure - can be navigated through the topic tree in the Qt Creator help viewer Task-number: QTBUG-126606 Change-Id: I548c9475cd731b0fb6d287712a6b27203d748fc8 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-08-15 09:18:56 +00:00
# Autogenerate navigation linking based on "All Topics":
navigation.toctitles = "All Topics"
navigation.toctitles.inclusive = false
Revamp documentation for Apple operating systems The documentation is now isolated into its own directory, and the Qt for macOS and Qt for iOS documentation has been given a unified structure. We now document the minimum version supported, as well as the maximum version that we've tested, but we also note that newer OS versions are supported, with the normal caveats that bugs may exist, and are fixed in accordance with the relevant branch policies. Pick-to: 6.8 6.5 Change-Id: I99c7a445ee10d1d76b1a25223f9d0086230a0334 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Vladimir Minenko <vladimir.minenko@qt.io>
2024-10-31 09:53:51 +00:00
# Apple platform versions
macro.macOSMinSdkVersion = $QT_SUPPORTED_MIN_MACOS_SDK_VERSION
macro.macOSMinXcodeVersion = $QT_SUPPORTED_MIN_MACOS_XCODE_VERSION
macro.macOSMinVersion = $QT_SUPPORTED_MIN_MACOS_VERSION
macro.macOSMaxVersionTested = $QT_SUPPORTED_MAX_MACOS_VERSION_TESTED
macro.iOSMinSdkVersion = $QT_SUPPORTED_MIN_IOS_SDK_VERSION
macro.iOSMinXcodeVersion = $QT_SUPPORTED_MIN_IOS_XCODE_VERSION
macro.iOSMinVersion = $QT_SUPPORTED_MIN_IOS_VERSION
macro.iOSMaxVersionTested = $QT_SUPPORTED_MAX_IOS_VERSION_TESTED
macro.visionOSMinSdkVersion = $QT_SUPPORTED_MIN_VISIONOS_SDK_VERSION
macro.visionOSMinXcodeVersion = $QT_SUPPORTED_MIN_VISIONOS_XCODE_VERSION
macro.visionOSMinVersion = $QT_SUPPORTED_MIN_VISIONOS_VERSION
macro.visionOSMaxVersionTested = $QT_SUPPORTED_MAX_VISIONOS_VERSION_TESTED