Files

Leena Miettinen 097cb17af4 Doc: Replace "Getting Help" with "How To"

Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>

2023-09-13 06:56:53 +00:00

config

Doc: Combine two topics about selecting modes into one

2023-07-04 11:12:20 +00:00

examples

Doc: Add setting up 3D scene tutorial

2023-06-30 09:32:37 +00:00

images

Docs: Update the plugin screenshot and add start sceen docs

2023-07-14 07:24:59 +00:00

src

Doc: Replace "Getting Help" with "How To"

2023-09-13 06:56:53 +00:00

qtdesignstudio-online.qdocconf

Doc: Qt Design Studio: Fix missing search results page in online builds

2021-11-08 14:42:21 +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

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

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
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.