feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
964f539e559f0bb51204a10ad6147bda3a1924d0
qt-creator/doc/qtdesignstudio
History
Tim Jenssen 964f539e55 Merge remote-tracking branch 'origin/8.0' into 9.0 
resolved conflicts:
* doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc
* src/plugins/qmldesigner/components/edit3d/edit3dwidget.cpp
* src/plugins/qmldesigner/components/materialbrowser/materialbrowserview.cpp
* src/plugins/qmldesigner/components/navigator/choosefrompropertylistdialog.cpp

and compile fix in materialbrowserview.cpp

Change-Id: I686e7e93ded8ac1afc792942ded47cd9fe4341ed
2022-10-04 13:44:42 +00:00
..
config
Doc: Exclude docker folder from QDS doc builds
2022-07-12 06:43:00 +00:00
examples
Merge remote-tracking branch 'origin/8.0' into 9.0
2022-10-04 13:44:42 +00:00
images
Doc: Update custom property documentation
2022-10-04 06:38:10 +00:00
src
Merge remote-tracking branch 'origin/8.0' into 9.0
2022-10-04 13:44:42 +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

  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.