feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
9c9ca280ea4e65d84d3640a4f894152f25e56d24
qt-creator/doc/qtdesignstudio
History
Leena Miettinen 01d7fcd8d8 Doc: Describe combining multiple logic helpers 
Also update docs according to the API review results.

Fixes: QDS-3581
Change-Id: I163b75421432391f4ffea334ffbc4ddacbf3e4e6
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
2021-02-16 12:12:41 +00:00
..
config
Doc: Hide Conan plugin doc sources from QDS doc builds
2021-01-28 13:03:08 +00:00
examples
Doc: Add docs for Washing Machine UI example
2021-02-04 11:47:38 +00:00
images
Doc: Describe combining multiple logic helpers
2021-02-16 12:12:41 +00:00
src
Doc: Describe combining multiple logic helpers
2021-02-16 12:12:41 +00:00
qtdesignstudio-online.qdocconf
Doc: Fix the \youtube macro for use with liteHTML help backend
2020-12-01 10:40:02 +00:00
qtdesignstudio.qdocconf
Doc: Add Qt Design Studio Manual sources
2020-01-20 13:54:38 +00:00
README.md
Doc: Update guidelines for writing Qt Creator documentation
2020-04-02 07:07:52 +00:00
studiodoc.pro
Doc: Add Qt Design Studio Manual sources
2020-01-20 13:54:38 +00:00

README.md

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

  1. Run qmake from 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
  2. Run make docs on Linux and macOS or nmake docs on Windows.

The docs are generated in qtcreator\doc\html\qtdesignstudio with the Qt Design Studio branding.