Commit Graph

28 Commits

Author SHA1 Message Date
Leena Miettinen
1956b0f698 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-07-04 11:12:20 +00:00
Leena Miettinen
1e1eba1a1a 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-08 08:54:20 +00:00
Leena Miettinen
57329c7cf9 Doc: Exclude docker folder from QDS doc builds
Task-number: QTCREATORBUG-27561
Change-Id: I3320579259bd5d15c407830176ac4be6d7f62942
Reviewed-by: hjk <hjk@qt.io>
2022-07-12 06:43:00 +00:00
Leena Miettinen
05d7343018 Doc: Copy icons from sources to images\icons
Copy black icons with white background to be able to
turn them gray with transparent background as a first
step of making them visible in both light and dark online
doc modes.

Task-number: QDS-5693
Change-Id: I317714ba355d7c05742434fcdcafa87aef732dd4
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-01-04 11:07:44 +00:00
Leena Miettinen
d420e7f5ee Doc: Fix paths to moved icons on the QDS side
- Copy missing icons from utils to doc/qtdesignstudio/images/icons
- Use gray-scale icons for keyframe icons

Task-number: QTCREATORBUG-26644
Change-Id: I3905f17317078b489ad3b33470657eb3e1fd48f5
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-12-10 17:30:30 +00:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Leena Miettinen
4b678f50bb 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-15 16:11:25 +00:00
Leena Miettinen
9ecbb3e4ee Doc: Fix the sidebar TOC in the online version
...to match the new structure.

Change-Id: I7b4ffe8f6ae7993906bb79bf470fc1883ca0a122
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2021-09-07 14:01:23 +00:00
Leena Miettinen
fbdec8ce21 Doc: Add docs for SimpleKeyboard example
Fixes: QDS-4140
Change-Id: Icf1da91512848881914ac4c44e47ecc6e5bc3903
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-27 11:37:00 +00:00
Aleksei German
ddc6380c1b QmlDesigner: Fix for qdocconfig variable
Change-Id: I75364da1614b7ec641ba1321892245709694978e
Fixes: QDS-4185
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-04-16 09:26:59 +00:00
Aleksei German
5be41e7ba1 Fix for QDS documentation generation
Change-Id: I66dc5912476719b9bb57d141784a6df7c7f55ac4
Fixes: QDS-4185
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-16 07:49:58 +00:00
Leena Miettinen
534e5101de 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 13:03:08 +00:00
Leena Miettinen
b9886a4b04 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-12-01 10:40:02 +00:00
Johanna Vanhatapio
6250b13eb3 Doc: Add a link to Getting Started Video 2
Change-Id: I912ac899e658945f4ede5eb0ad5da70fa3df622d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-30 14:48:50 +00:00
Leena Miettinen
7f28237915 Doc: Add support for the \youtube macro
Show links to Youtube videos using thumbnails with a play button.

Change-Id: I131f24b1fb723c817c2387429bbf52997003f105
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-11-27 13:51:31 +00:00
Leena Miettinen
652feacd5f 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-28 14:04:04 +00:00
Leena Miettinen
46a9e35c28 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-02 12:54:13 +00:00
Leena Miettinen
2e1eed1945 Doc: Add list to words to ignore for automatic linking
Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 12:45:19 +00:00
Leena Miettinen
c11c09386c Doc: Fix link to Adding Dynamics from online doc sidebar TOC
Change-Id: I7e4de42079cde8c6b7b0315968e5f17c529648e6
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-04 08:53:57 +00:00
Leena Miettinen
6181399187 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-28 10:06:06 +00:00
Leena Miettinen
ed95b3e6a1 Doc: Add info about IncrediBuild plugin
Fixes: QTCREATORBUG-24217
Change-Id: I3e9023933db508f14139b719eae0191d4615eab7
Reviewed-by: hjk <hjk@qt.io>
2020-08-11 07:53:36 +00:00
Leena Miettinen
7f436e23ac 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-03 06:20:33 +00:00
Leena Miettinen
f51258a17c Doc: Move Qt Bridge product name macros to the common macros file
..from the Qt Design Studio Manual doc configuration file.

Change-Id: Iebbfb5404cae4ef277f05c867e7259997b19a27e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-14 10:18:31 +00:00
Tim Jenssen
081186811d qds: remove workaround when qdocconf was somewhere else
After moving the QtDesignStudio documentation to the QtCreator
repository there is no need for these extra files in the dev
packages.

Change-Id: I4e24946bb6752403a6ecafb0c474332ad2317b1a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-24 08:34:16 +00:00
Leena Miettinen
169c3bb30c Doc: Fix path to image files
Change-Id: I8f9395bd5d8c5ae02e1bb994577b02c80c4c2564
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-04-23 12:42:47 +00:00
Leena Miettinen
1e9a91e7d1 Doc: Fix the Qt Design Studio Manual sidebar TOC
Fixes: QDS-1889
Change-Id: Ie74a1af668457c18a2ec167f934f0de796251816
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-04-02 09:46:11 +00:00
Leena Miettinen
5fc456dd22 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-27 09:05:07 +00:00
Leena Miettinen
4a971127ac 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-20 13:54:38 +00:00