49d20960b9
- Moved the topic from the creator-only folder to the howto folder root to have it included in the doc builds. - Added the topic to the toc and fixed the navigation links around it. - Used defines to hide text that does not apply to QDS. Fixes: QDS-2805 Change-Id: I583324a1d0bc60c1b6448a52e48b3f09b1039b7f Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Writing Qt Design Studio Documentation
The Qt Design Studio Manual is based on the Qt Creator Manual, with additional topics. When building the Qt Design Studio Manual, parts of the Qt Creator Manual are pulled in from Qt Creator sources. This is enabled by creating separate table of contents files for each Manual and by using defines to hide and show information depending on which Manual is being built.
Because branding information is needed to use the correct product name and
version, you must run qmake -r on qtcreator.pro with the IDE_BRANDING_PRI
option set to the absolute path of ide_branding.pri in the Qt Design Studio
repository.
For example, on Windows enter (all on one line):
C:\dev\qtc-super\qtcreator>..\..\..\Qt\5.14.1\msvc2017_64\bin\qmake.exe qtcreator.pro -r IDE_BRANDING_PRI=C:\dev\tqtc-plugin-qtquickdesigner\studiodata\branding\ide_branding.pri
Building the Qt Design Studio Manual
- Run
qmakefrom Qt 5.14.0, or later with the path to the branding information as a parameter:<relative_path_to>\qmake.exe qtcreator.pro -r IDE_BRANDING_PRI=<absolute_path_to>\tqtc-plugin-qtquickdesigner\studiodata\branding\ide_branding.pri - Run
make docson Linux and macOS ornmake docson Windows.
The docs are generated in qtcreator\doc\html\qtdesignstudio with the
Qt Design Studio branding.