feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
cc05c1637778db8210ea901b8da71aeef1bde05e
qt-creator/doc/qtdesignstudio/config/qtdesignstudio.qdocconf

129 lines
4.6 KiB
Plaintext
Raw Normal View History

QmlDesigner: Fix for qdocconfig variable Change-Id: I75364da1614b7ec641ba1321892245709694978e Fixes: QDS-4185 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-16 10:29:38 +02:00
project = $IDE_ID
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
description = "$IDE_DISPLAY_NAME Manual"
url = https://doc.qt.io/qtdesignstudio
Fix for QDS documentation generation Change-Id: I66dc5912476719b9bb57d141784a6df7c7f55ac4 Fixes: QDS-4185 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-15 17:27:32 +02:00
version = $QTC_VERSION
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
Doc: Add list to words to ignore for automatic linking Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 14:43:02 +02:00
#Words to ignore for auto-linking
ignorewords += \
macOS \
WebChannel \
WebSocket \
WebSockets \
OpenGL \
MinGW
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
headerdirs =
sourcedirs = ../src \
../examples/doc \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
imagedirs = ../images \
../examples/doc/images \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/images \
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
../../../share/qtcreator/qml/qmlpuppet/mockfiles/images \
../../../share/qtcreator/qmldesigner/propertyEditorQmlSources/imports/HelperWidgets/images \
../../../src/libs/qmleditorwidgets/images \
../../../src/plugins/qmldesigner/components/componentcore/images \
Doc: Fix path to image files Change-Id: I8f9395bd5d8c5ae02e1bb994577b02c80c4c2564 Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-04-23 10:49:05 +02:00
../../../src/plugins/qmldesigner/components/edit3d/images \
Doc: Describe Positioner and Layout type properties Move positioning to a separate topic. The information in this topic is related not only to the Library view, but also to the Properties and Form Editor views. Describe the properties of the Positioner and Layout types. Change-Id: I9d00bc9498499f52ecf49463df7f651aaecf8f0e Reviewed-by: Alessandro Portale <alessandro.portale@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-10-02 12:07:15 +02:00
../../../src/plugins/qmldesigner/componentsplugin/images \
Doc: Describe properties of Studio Components (shapes) And the basic Rectangle. Fixes: QDS-2848 Change-Id: I6a0f506ed1f1c0ec3d065823131e7eb48445c6e2 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-10-01 16:48:17 +02:00
../../../src/plugins/qmldesigner/qtquickplugin/images \
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
Doc: Fix the \youtube macro for use with liteHTML help backend Create a common directory for extra image files, and move the video thumbnails there. This folder structure is required to work around the fact that relative image paths passed to qhp.<project>.extraFiles are not resolved correctly when loading the generated help project. Change-Id: Iff5583a9a318670571b7f706182723e54e0ec466 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 18:21:33 +01:00
include(../../qtcreator/images/extraimages/qtdesignstudio-extraimages.qdocconf)
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
excludefiles += ../../qtcreator/src/qtcreator.qdoc \
../../qtcreator/src/qtcreator-toc.qdoc
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
excludedirs += ../../qtcreator/examples/accelbubble \
../../qtcreator/examples/textfinder \
../../qtcreator/examples/transitions \
../../qtcreator/src/analyze \
../../qtcreator/src/android \
Doc: Describe the application manager plugin Task-number: QTCREATORBUG-30209 Change-Id: Icd40d6da99e7fa53f667745a4de32b03b1157c99 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
2024-03-05 17:17:22 +01:00
../../qtcreator/src/appman \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/baremetal \
../../qtcreator/src/cmake \
Doc: Hide Conan plugin doc sources from QDS doc builds Conan is not used with QDS, so the docs are not a part of QDS Manual. Change-Id: I539afb58dd9762d088d2d22ea9793f819f89168a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-01-28 14:01:32 +01:00
../../qtcreator/src/conan \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/debugger/creator-only \
Doc: Exclude docker folder from QDS doc builds Task-number: QTCREATORBUG-27561 Change-Id: I3320579259bd5d15c407830176ac4be6d7f62942 Reviewed-by: hjk <hjk@qt.io>
2022-07-11 17:00:26 +02:00
../../qtcreator/src/docker \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/editors/creator-only \
../../qtcreator/src/howto/creator-only \
Doc: Add info about IncrediBuild plugin Fixes: QTCREATORBUG-24217 Change-Id: I3e9023933db508f14139b719eae0191d4615eab7 Reviewed-by: hjk <hjk@qt.io>
2020-08-07 16:33:55 +02:00
../../qtcreator/src/incredibuild \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/ios \
../../qtcreator/src/linux-mobile \
../../qtcreator/src/mcu \
Doc: Add "Setting Up Meson" to "All Topics" To display it correctly in the Help Contents. Also exclude the topic from the Qt Design Studio Manual build. Change-Id: I2536ef7214faf12c3e1ff533449db12f87a58aeb Reviewed-by: Alexis Jeandet <alexis.jeandet@member.fsf.org> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-07-02 17:15:01 +02:00
../../qtcreator/src/meson \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/overview/creator-only \
../../qtcreator/src/projects \
Doc: Describe new Qt for Python support features Add an overview page for Developing Qt for Python applications. It contains links to Python-related information in the manual and some sections about setting up the development environment. Task-number: QTCREATORBUG-28996 Change-Id: If5a442415bad65aa94aa78183d44c6e0f78e317e Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
2023-06-07 11:53:09 +02:00
../../qtcreator/src/python \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/qnx \
../../qtcreator/src/qtquick/creator-only \
Doc: Combine two topics about selecting modes into one Move information from "Selecting Modes" to "Switch between modes". Hide it from the QDS Manual because modes are hidden by default in QDS. Task-number: QTCREATORBUG-28996 Change-Id: I6d281fe9364e191616af3a8ac484dd0a7d6a3156 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-06-30 14:47:34 +02:00
../../qtcreator/src/user-interface/creator-only \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/src/vcs/creator-only \
../../qtcreator/src/widgets \
../../qtcreator/src/webassembly
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
exampledirs = ../examples/ \
Doc: Rearrange files in the doc folder Source and configuration files for each manual are now located in a separate subdirectory, with common configuration files in doc/config. doc |_config |_qtcreator |_qtcreatordev |_qtdesignstudio Edit the config files accordingly. Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-23 11:45:07 +01:00
../../qtcreator/examples
Doc: Update first part of entry-level tutorial Task-number: QDS-5001 Change-Id: I2520d843a292f80473411ee94df8253bb097b22f Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-09-07 18:03:26 +02:00
examples.fileextensions += *.qml *.ts *.qm
examples.imageextensions = "*.svg *.png *.jpg *.gif"
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
depends += qtwidgets \
qtcore \
qtqml \
qtqmlmodels \
qtquick \
qmake \
qtdoc \
qtgraphicaleffects \
qtgui \
qthelp \
qtquick3d \
qtquickcontrols \
qtquickextras \
qtquicktimeline \
qtlinguist \
qtscxml \
qtsensors \
qttestlib \
qtuitools \
Doc: Add docs for SimpleKeyboard example Fixes: QDS-4140 Change-Id: Icf1da91512848881914ac4c44e47ecc6e5bc3903 Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-23 16:37:09 +02:00
qtvirtualkeyboard \
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
qtxml
include(../../config/macros.qdocconf)
include(../../config/qt-cpp-ignore.qdocconf)
include(../../config/qt-defines.qdocconf)
defines += qtdesignstudio
sources.fileextensions = "*.qdoc" "*.qdocinc"
#depends += qtcreator \
# qmake
qhp.projects = qtdesignstudio
qhp.qtdesignstudio.file = qtdesignstudio.qhp
qhp.qtdesignstudio.namespace = org.qt-project.$IDE_ID.$QTC_VERSION_TAG
qhp.qtdesignstudio.virtualFolder = doc
qhp.qtdesignstudio.indexTitle = $IDE_DISPLAY_NAME Manual $QTC_VERSION
qhp.qtdesignstudio.filterAttributes = $IDE_ID $QTC_VERSION
qhp.qtdesignstudio.customFilters.qtdesignstudio.name = $IDE_DISPLAY_NAME $QTC_VERSION
qhp.qtdesignstudio.customFilters.qtdesignstudio.filterAttributes = $IDE_ID $QTC_VERSION
qhp.qtdesignstudio.indexRoot =
qhp.qtdesignstudio.subprojects = manual
qhp.qtdesignstudio.subprojects.manual.title = $IDE_DISPLAY_NAME Manual
qhp.qtdesignstudio.subprojects.manual.indexTitle = All Topics
qhp.qtdesignstudio.subprojects.manual.type = manual
# Doxygen compatibility commands
macro.see = "\\sa"
macro.function = "\\fn"
Doc: Use local value for \QMLD macro in Qt Design Studio Manual This enables us to get rid of the product name "Qt Quick Designer" in Qt Design Studio context. However, the macro can no longer be used for UI text. Actually, it does not make much sense, because the UI text is not dynamic. It would be good to also replace it in the UI with something more generic, or with "Form Editor", for example. Change-Id: I5884f090f915d5ff0c64428239bfd324cd1941c2 Reviewed-by: Brook Cronin <brook.cronin@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-08-25 09:44:15 +02:00
macro.QMLD = "Qt Design Studio"
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
navigation.landingpage = "$IDE_DISPLAY_NAME Manual"
Doc: Auto-generate navigation links based on "All Topics" This does not change what you see as values of \previouspage and \nextpage in the source files. However, when you build the docs, QDoc replaces those values with links to the next and previous page from the list in qtdesignstudio-toc.qdoc because that page contains "\title All Topics". So, with this change, you need to keep the list in "All Topics" up to date. Change-Id: I0996e383cbd60b7f4297524e4141a2d7af6fae13 Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io> Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-18 10:47:55 +01:00
# Auto-generate navigation linking based on "All Topics":
navigation.toctitles = "All Topics"
navigation.toctitles.inclusive = false
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
buildversion = "$IDE_DISPLAY_NAME Manual $QTC_VERSION"
Copy Permalink