Commit Graph

29 Commits

Author SHA1 Message Date
Leena Miettinen
78f3dfad87 Doc: Make the \page value consistent with that for other tutorials
Fix the link in the TOC sidebar online.

Change-Id: I4522c7b65be6498797e5945f3e9c6dc4b4f3966b
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-21 12:00:12 +00:00
David Schulz
a3668827aa Doc: improve create python project tutorials
Use consistent paths in screenshots and instructions. The paths from the
screenshots are preferable since they are not inside a default Qt
installation location.

Change-Id: If9f0bca58a13a66559eae953ccaf19abb2dc7e14
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:14:41 +00:00
Leena Miettinen
11c1e071d7 Doc: Update the docs about Python development
Task-number: QTCREATORBUG-30209
Change-Id: I3023fb6b9005092ecd76f62774942f366e1bd7d9
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-02-23 13:05:22 +00:00
Leena Miettinen
24797179a7 Doc: Remove "Managing Projects"
This topic is not used anymore.

Task-number: QTCREATORBUG-29361
Change-Id: Ia4d54a77fb3aac2e98fc00d697b045aee798b1ae
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-02-02 08:19:29 +00:00
Leena Miettinen
ab81f02b13 Doc: Describe the Generate Kit option for Python interpreters
Task-number: QTCREATORBUG-30209
Change-Id: I5eec3797d226109eccf4dde5f32b21076c18f2b4
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-01-15 13:20:44 +00:00
Leena Miettinen
78b6306578 Doc: Split up "Using Language Servers"
Update information about changed or added features.

Task-number: QTCREATORBUG-29361
Change-Id: Ia318b987602141f0021abd561ce3aac1d405904f
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-01-11 13:15:59 +00:00
Leena Miettinen
fa17c9b8fa Doc: List Kit preferences under Preferences > Kits
Add "\target kits-tab" for the Kits tab docs because the links need to
be unique.

Task-number: QTCREATORBUG-29361
Change-Id: I76058c521a4e2c08f24ea2f03846bef6eac9716a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-11 09:11:44 +00:00
Leena Miettinen
f708e200f9 Doc: Restructure info about build and run configurations
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-12-05 12:30:54 +00:00
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Leena Miettinen
22476fc26f Doc: Divide "Creating Projects" into an explanation and how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: I623d824e423da950df9643c42d85b485daccfe4b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-08-28 09:55:57 +00:00
Leena Miettinen
4c4719f4d0 Doc: Turn Qt for Python wizard docs into tutorials
Remove the Python instructions from Creating Projects and
turn them into Qt Quick and Qt Widgets tutorials.

Turn the Developing Qt for Python Applications topic into
a How-to.

Change-Id: Ia3b547fbefd5f8e6b67d673b9724cd6e3f0b4424
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-08-28 09:55:01 +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
e7b5e64a70 Doc: Remove detailed info about wizard templates
Improve descriptions of some wizard templates.

Task-number: QTCREATORBUG-28996
Change-Id: Ib53fa38918120af60a03f3850fed7db1e6f0c391
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-04-26 12:18:57 +00:00
Leena Miettinen
2c9ca6008f Doc: Describe Python interpreter selector on editor toolbar
Task-number: QTCREATORBUG-28721
Change-Id: I354c19a72e428e5361eaacb45f79c057affb9cb1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-24 07:26:51 +00:00
Leena Miettinen
447f8b80c3 Doc: Remove double words and fix a typo
For example, "and and", "the the", "or or"...

Change-Id: Ie5795efb857e674c5a584e97a60bcb9b2ba869d2
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-07 07:23:13 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00
Leena Miettinen
ce0f48e0f9 Doc: Replace "contain" with "have" to simplify language
This follows the ComplexWords rule in vale.

Change-Id: Ie5dbb7ac1eff1546dcfbe2bf5da6cc3ed18b7a20
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-03 15:06:17 +00:00
Leena Miettinen
b59ad8b0a9 Doc: Use active voice instead of passive voice
This fixes issues found by vale.

Change-Id: Ic3495633cc3aabd000e53b4a4107b9bccde28005
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2022-11-11 09:43:32 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Leena Miettinen
5edfb1b7e5 Doc: Match Python code in manual with code generated by wizards
Task-number: QTCREATORBUG-27560
Change-Id: Iff442279b99e05a577dc791ca88345a81d7bf564
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
2022-07-08 11:29:43 +00:00
Leena Miettinen
47b9183142 Doc: Describe new Python options
- Installing PySide6 and Python language server when prompted
- Python Interpreter preferences

Task-number: QTCREATORBUG-27560
Change-Id: I62f5aae381821bb0e81dffe76de61a8ec057d190
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-07-01 10:21:49 +00:00
Cristián Maureira-Fredes
ba693efdd3 python: update docs related to using ui files
This changes the tutorial described in the Creator docs
for the UI-based Python application.

The main reason is that loading an ui file is not recommended,
and discouraged over using uic tools to generate Python code
from ui files.

Some changes to code styling were included to the file as well,
mainly the exec_() to exec() changes.

Change-Id: Ibe1f4d62d2252edecd5f3475250f1287d8213faa
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-06-02 13:31:51 +00:00
Leena Miettinen
ffc30fedc9 Doc: Describe creating a PySide6 project with the wizard
Task-number: QTCREATORBUG-26278
Change-Id: I643a10cff0a30f0de31851dc5d2077c11248f62e
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
2021-11-15 09:28:03 +00:00
Leena Miettinen
ac2906cd60 Doc: Update info about available project wizard templates
The Qt Quick Application wizard template was simplified.

Change-Id: I716d8d03aa508b6f8204b028c5e11691e1e469c3
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-10-20 09:00:50 +00:00
Leena Miettinen
cb5b0cffb3 Doc: Describe starting Python interactive shell with options
Change-Id: Ife42fd2313b4855686abf12fd536e024f7650ef9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-25 10:05:53 +00:00
Leena Miettinen
b7e5362e8f Doc: Update info about run settings
Task-number: QTCREATORBUG-23364
Change-Id: I5753db6a82e62a371b9d5fb89c01d3ec87676ad3
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-04-20 11:06:29 +00:00
Leena Miettinen
a7b7c31c9c Doc: Update info on Python run settings
Change-Id: Ia1da720286205bae18c7a01538430740510b9780
Reviewed-by: David Schulz <david.schulz@qt.io>
2020-03-25 08:22:57 +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