Skip to content

Commit 128fa5b

Browse files
KidevKidev
authored
Update docs for more recent versions of Qt, and for WASM (#876)
* Update getting_started.rst * Update getting_started.rst * Update cli.rst * Specify one command is for Qt5 only
1 parent a09b5ce commit 128fa5b

File tree

2 files changed

+92
-58
lines changed

2 files changed

+92
-58
lines changed

‎docs/cli.rst

+45-37
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ List available versions of Qt, targets, modules, and architectures.
5454

5555
.. describe:: host
5656

57-
linux, linux_arm64, windows or mac
57+
linux, linux_arm64, windows, mac or all_os for Qt 6.7+
5858

5959
.. describe:: target
6060

61-
desktop, winrt, ios or android.
61+
desktop, winrt, ios, android or wasm for Qt 6.7+
6262
When omitted, the command prints all the targets available for a host OS.
6363
Note that winrt is only available on Windows, and ios is only available on Mac OS.
6464

@@ -84,7 +84,7 @@ List available versions of Qt, targets, modules, and architectures.
8484
This flag lists all the modules available for Qt 5.X.Y with a host/target/architecture
8585
combination, or the latest version of Qt if ``latest`` is specified.
8686
You can list available architectures by using ``aqt list-qt`` with the
87-
``--arch`` flag described below.
87+
``--arch`` flag described below. As of Qt 6.7 this also lists extensions.
8888

8989
.. option:: --long-modules (<Qt version> | latest) <architecture>
9090

@@ -96,37 +96,41 @@ List available versions of Qt, targets, modules, and architectures.
9696
.. code-block:: console
9797
9898
$ python -m aqt list-qt windows desktop --long-modules latest win64_mingw
99-
100-
Module Name Display Name Release Date Download Size Installed Size
101-
=======================================================================================================================
102-
debug_info Desktop MinGW 11.2.0 64-bit debug information files 2022-07-07 1.0G 6.4G
103-
qt3d Qt 3D for MinGW 11.2.0 64-bit 2022-07-07 2.8M 21.3M
104-
qt5compat Qt 5 Compatibility Module for MinGW 11.2.0 64-bit 2022-07-07 679.3K 2.5M
105-
qtactiveqt Qt 3D for MinGW 11.2.0 64-bit 2022-07-07 5.9M 32.6M
106-
qtcharts Qt Charts for MinGW 11.2.0 64-bit 2022-07-07 713.0K 7.5M
107-
qtconnectivity Qt Connectivity for MinGW 11.2.0 64-bit 2022-07-07 227.5K 1.5M
108-
qtdatavis3d Qt Data Visualization for MinGW 11.2.0 64-bit 2022-07-07 565.7K 4.3M
109-
qthttpserver Qt HTTP Server for MinGW 11.2.0 64-bit 2022-07-07 73.2K 372.6K
110-
qtimageformats Qt Image Formats for MinGW 11.2.0 64-bit 2022-07-07 184.6K 705.5K
111-
qtlanguageserver Qt language Server for MinGW 11.2.0 64-bit 2022-07-07 300.1K 1.8M
112-
qtlottie Qt Lottie Animation for MinGW 11.2.0 64-bit 2022-07-07 131.7K 704.0K
113-
qtmultimedia Qt Multimedia for MinGW 11.2.0 64-bit 2022-07-07 9.7M 79.2M
114-
qtnetworkauth Qt Network Authorization for MinGW 11.2.0 64-bit 2022-07-07 85.5K 507.6K
115-
qtpositioning Qt Positioning for MinGW 11.2.0 64-bit 2022-07-07 347.2K 2.2M
116-
qtquick3d Qt Quick 3D for MinGW 11.2.0 64-bit 2022-07-07 13.0M 75.4M
117-
qtquick3dphysics Quick: 3D Physics for MinGW 11.2.0 64-bit 2022-07-07 35.5M 203.9M
118-
qtquicktimeline Qt Quick Timeline for MinGW 11.2.0 64-bit 2022-07-07 54.6K 301.4K
119-
qtremoteobjects Qt Remote Objects for MinGW 11.2.0 64-bit 2022-07-07 424.4K 2.0M
120-
qtscxml Qt State Machine for MinGW 11.2.0 64-bit 2022-07-07 448.5K 2.9M
121-
qtsensors Qt Sensors for MinGW 11.2.0 64-bit 2022-07-07 175.7K 2.0M
122-
qtserialbus Qt SerialBus for MinGW 11.2.0 64-bit 2022-07-07 208.8K 1.2M
123-
qtserialport Qt SerialPort for MinGW 11.2.0 64-bit 2022-07-07 58.3K 255.3K
124-
qtshadertools Qt Shader Tools for MinGW 11.2.0 64-bit 2022-07-07 1.2M 4.1M
125-
qtspeech Qt Speech for MinGW 11.2.0 64-bit 2022-07-07 81.8K 427.9K
126-
qtvirtualkeyboard Qt Virtual Keyboard for MinGW 11.2.0 64-bit 2022-07-07 2.1M 6.0M
127-
qtwebchannel Qt WebChannel for MinGW 11.2.0 64-bit 2022-07-07 114.0K 500.3K
128-
qtwebsockets Qt WebSockets for MinGW 11.2.0 64-bit 2022-07-07 96.3K 509.6K
129-
qtwebview Qt WebView for MinGW 11.2.0 64-bit 2022-07-07 64.2K 470.7K
99+
Module Name Display Name Release Date Download Size Installed Size
100+
========================================================================================================================
101+
debug_info Desktop MinGW 13.1.0 64-bit debug information files 2024-12-12 912.6M 5.7G
102+
qt3d Qt 3D for MinGW 13.1.0 64-bit 2024-12-12 3.4M 26.5M
103+
qt5compat Qt 5 Compatibility Module for MinGW 13.1.0 64-bit 2024-12-12 768.6K 3.2M
104+
qtactiveqt Active Qt for MinGW 13.1.0 64-bit 2024-12-12 6.4M 35.1M
105+
qtcharts Qt Charts for MinGW 13.1.0 64-bit 2024-12-12 836.5K 8.7M
106+
qtconnectivity Qt Connectivity for MinGW 13.1.0 64-bit 2024-12-12 259.2K 1.8M
107+
qtdatavis3d Qt Data Visualization for MinGW 13.1.0 64-bit 2024-12-12 636.4K 5.0M
108+
qtgraphs Qt Graphs for MinGW 13.1.0 64-bit 2024-12-12 843.2K 6.9M
109+
qtgrpc Qt Protobuf and Qt GRPC for MinGW 13.1.0 64-bit 2024-12-12 4.1M 34.7M
110+
qthttpserver Qt HTTP Server for MinGW 13.1.0 64-bit 2024-12-12 106.0K 563.2K
111+
qtimageformats Qt Image Formats for MinGW 13.1.0 64-bit 2024-12-12 427.2K 1.5M
112+
qtlanguageserver Qt language Server for MinGW 13.1.0 64-bit 2024-12-12 7.7M 56.1M
113+
qtlocation Qt Location for MinGW 13.1.0 64-bit 2024-12-12 718.1K 5.9M
114+
qtlottie Qt Lottie Animation for MinGW 13.1.0 64-bit 2024-12-12 161.2K 951.5K
115+
qtmultimedia Qt Multimedia for MinGW 13.1.0 64-bit 2024-12-12 18.0M 107.6M
116+
qtnetworkauth Qt Network Authorization for MinGW 13.1.0 64-bit 2024-12-12 128.4K 811.7K
117+
qtpdf MinGW 13.1.0 x64 2024-12-12 4.0M 11.1M
118+
qtpositioning Qt Positioning for MinGW 13.1.0 64-bit 2024-12-12 414.3K 2.8M
119+
qtquick3d Qt Quick 3D for MinGW 13.1.0 64-bit 2024-12-12 18.0M 102.1M
120+
qtquick3dphysics Qt Quick 3D Physics for MinGW 13.1.0 64-bit 2024-12-12 35.0M 198.8M
121+
qtquickeffectmaker Qt Quick Effect Maker for MinGW 13.1.0 64-bit 2024-12-12 3.8M 5.0M
122+
qtquicktimeline Qt Quick Timeline for MinGW 13.1.0 64-bit 2024-12-12 91.7K 646.7K
123+
qtremoteobjects Qt Remote Objects for MinGW 13.1.0 64-bit 2024-12-12 486.9K 2.3M
124+
qtscxml Qt State Machine for MinGW 13.1.0 64-bit 2024-12-12 539.5K 3.6M
125+
qtsensors Qt Sensors for MinGW 13.1.0 64-bit 2024-12-12 206.8K 2.3M
126+
qtserialbus Qt SerialBus for MinGW 13.1.0 64-bit 2024-12-12 300.7K 1.8M
127+
qtserialport Qt SerialPort for MinGW 13.1.0 64-bit 2024-12-12 76.3K 377.8K
128+
qtshadertools Qt Shader Tools for MinGW 13.1.0 64-bit 2024-12-12 1.5M 5.4M
129+
qtspeech Qt Speech for MinGW 13.1.0 64-bit 2024-12-12 124.7K 686.3K
130+
qtvirtualkeyboard Qt Virtual Keyboard for MinGW 13.1.0 64-bit 2024-12-12 2.2M 7.1M
131+
qtwebchannel Qt WebChannel for MinGW 13.1.0 64-bit 2024-12-12 139.8K 722.6K
132+
qtwebsockets Qt WebSockets for MinGW 13.1.0 64-bit 2024-12-12 117.9K 679.9K
133+
qtwebview Qt WebView for MinGW 13.1.0 64-bit 2024-12-12 84.8K 687.8K
130134
131135
132136
.. option:: --arch (<Qt version> | latest)
@@ -506,7 +510,7 @@ There are various combinations to accept according to Qt version.
506510
507511
.. describe:: target
508512
509-
desktop, ios, winrt, or android. The type of device for which you are developing Qt programs.
513+
desktop, ios, winrt, android, or wasm. The type of device for which you are developing Qt programs.
510514
If your target is ios, please be aware that versions of Qt older than 6.2.4 are expected to be
511515
non-functional with current versions of XCode (applies to any XCode greater than or equal to 13).
512516
@@ -545,6 +549,8 @@ There are various combinations to accept according to Qt version.
545549
546550
* android_armv7, android_arm64_v8a, android_x86, android_x86_64 for android
547551
552+
* wasm_singlethread or wasm_multithread for wasm
553+
548554
Use the :ref:`List-Qt Command` to list available architectures.
549555
550556
.. option:: --autodesktop
@@ -842,18 +848,20 @@ Example: Print modules available for installation with ``install-example/doc``:
842848
aqt list-example windows 5.15.2 --modules
843849
aqt list-doc windows 5.15.2 --modules
844850
845-
Example: Install Web Assembly
851+
Example: Install Web Assembly for Qt5
846852
847853
.. code-block:: console
848854
849855
aqt install-qt linux desktop 5.15.0 wasm_32
850856
851857
852-
Example: Install Qt6 for Web Assembly
858+
Example: Install different versions of Qt6 for Web Assembly (WASM)
853859
854860
.. code-block:: console
855861
856862
aqt install-qt linux desktop 6.2.4 wasm_32 --autodesktop
863+
aqt install-qt linux desktop 6.5.0 wasm_singlethread --autodesktop
864+
aqt install-qt all_os wasm 6.8.0 wasm_multithread --autodesktop
857865
858866
859867
Example: List available versions of Qt on Linux

‎docs/getting_started.rst

+47-21
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Some older operating systems may require you to specify Python version 3, like t
2929

3030
To use ``aqt`` to install Qt, you will need to tell ``aqt`` four things:
3131

32-
1. The host operating system (windows, mac, linux, or linux_arm64)
33-
2. The target SDK (desktop, android, ios, or winrt)
32+
1. The host operating system (windows, mac, linux, linux_arm64, or all_os for Qt 6.7+)
33+
2. The target SDK (desktop, android, ios, winrt, or wasm for Qt 6.7+)
3434
3. The version of Qt you would like to install
3535
4. The target architecture
3636

@@ -41,6 +41,8 @@ In current versions of Qt, mac binaries are universal.
4141
As of Qt 6.7.0, Linux desktop now supports the arm64 architecture.
4242
This is implemented as a new host type - ``linux`` is amd64, ``linux_arm64`` is arm64.
4343

44+
As of Qt 6.7.0, the WASM architecture can be installed using ``all_os`` as host and ``wasm`` as target.
45+
4446
To find out what versions of Qt are available, you can use the :ref:`aqt list-qt command <list-qt command>`.
4547
This command will print all versions of Qt available for Windows Desktop:
4648

@@ -50,13 +52,20 @@ This command will print all versions of Qt available for Windows Desktop:
5052
5.9.0 5.9.1 5.9.2 5.9.3 5.9.4 5.9.5 5.9.6 5.9.7 5.9.8 5.9.9
5153
5.10.0 5.10.1
5254
5.11.0 5.11.1 5.11.2 5.11.3
53-
5.12.0 5.12.1 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.12.10 5.12.11
55+
5.12.0 5.12.1 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.12.10 5.12.11 5.12.12
5456
5.13.0 5.13.1 5.13.2
5557
5.14.0 5.14.1 5.14.2
5658
5.15.0 5.15.1 5.15.2
5759
6.0.0 6.0.1 6.0.2 6.0.3 6.0.4
58-
6.1.0 6.1.1 6.1.2
59-
6.2.0
60+
6.1.0 6.1.1 6.1.2 6.1.3
61+
6.2.0 6.2.1 6.2.2 6.2.3 6.2.4
62+
6.3.0 6.3.1 6.3.2
63+
6.4.0 6.4.1 6.4.2 6.4.3
64+
6.5.0 6.5.1 6.5.2 6.5.3
65+
6.6.0 6.6.1 6.6.2 6.6.3
66+
6.7.0 6.7.1 6.7.2 6.7.3
67+
6.8.0 6.8.1
68+
6.9.0
6069
6170
Notice that the version numbers are sorted, grouped by minor version number,
6271
and separated by a single space-character. The output of all of the
@@ -70,38 +79,38 @@ so it may or may not be up to date.
7079

7180
.. _Available Qt versions: https://github.com/miurahr/aqtinstall/wiki/Available-Qt-versions
7281

73-
Now that we know what versions of Qt are available, let's choose version 6.2.0.
82+
Now that we know what versions of Qt are available, let's choose version 6.8.0.
7483

7584
The next thing we need to do is find out what architectures are available for
76-
Qt 6.2.0 for Windows Desktop. To do this, we can use :ref:`aqt list-qt <list-qt command>` with the
85+
Qt 6.8.0 for Windows Desktop. To do this, we can use :ref:`aqt list-qt <list-qt command>` with the
7786
``--arch`` flag:
7887

7988
.. code-block:: console
8089
81-
$ aqt list-qt windows desktop --arch 6.2.0
82-
win64_mingw81 win64_msvc2019_64 win64_msvc2019_arm64 wasm_32
90+
$ aqt list-qt windows desktop --arch 6.8.0
91+
win64_llvm_mingw win64_mingw win64_msvc2022_64 win64_msvc2022_arm64_cross_compiled
8392
8493
Notice that this is a very small subset of the architectures listed in the
8594
`Available Qt versions`_ wiki page. If we need to use some architecture that
8695
is not on this list, we can use the `Available Qt versions`_ wiki page to get
8796
a rough idea of what versions support the architecture we want, and then use
8897
:ref:`aqt list-qt <list-qt command>` to confirm that the architecture is available.
8998

90-
Let's say that we want to install Qt 6.2.0 with architecture ``win64_mingw81``.
99+
Let's say that we want to install Qt 6.8.0 with architecture ``win64_mingw``.
91100
The installation command we need is:
92101

93102
.. code-block:: console
94103
95-
$ aqt install-qt windows desktop 6.2.0 win64_mingw81
104+
$ aqt install-qt windows desktop 6.8.0 win64_mingw
96105
97-
Let's say that we want to install the next version of Qt 6.2 as soon as it is available.
106+
Let's say that we want to install the next version of Qt 6.8 as soon as it is available.
98107
We can do this by using a
99108
`SimpleSpec <https://python-semanticversion.readthedocs.io/en/latest/reference.html#semantic_version.SimpleSpec>`_
100109
instead of an explicit version:
101110

102111
.. code-block:: console
103112
104-
$ aqt install-qt windows desktop 6.2 win64_mingw81
113+
$ aqt install-qt windows desktop 6.8 win64_mingw
105114
106115
As of Qt 6.7.0, arm64 architecture is now supported for linux desktop.
107116
It is implemented using both a different host (``linux_arm64``) and architecture (``linux_gcc_arm64``).
@@ -110,6 +119,13 @@ It is implemented using both a different host (``linux_arm64``) and architecture
110119
111120
$ aqt install-qt linux_arm64 desktop 6.7.0 linux_gcc_arm64
112121
122+
As of Qt 6.7.0, the WASM architecture can be installed using ``all_os`` as host and ``wasm`` as target.
123+
The available architectures are ``wasm_singlethread`` and ``wasm_multithread``
124+
125+
.. code-block:: console
126+
127+
$ aqt install-qt all_os wasm 6.7.0 wasm_singlethread
128+
113129
External 7-zip extractor
114130
------------------------
115131

@@ -120,14 +136,14 @@ you could use 7-zip_ on a Windows desktop, using this command:
120136

121137
.. code-block:: doscon
122138
123-
C:\> aqt install-qt windows desktop 6.2.0 gcc_64 --external 7za.exe
139+
C:\> aqt install-qt windows desktop 6.8.0 win64_msvc2022_64 --external 7za.exe
124140
125141
On Linux, you can specify p7zip_, a Linux port of 7-zip_, which is often
126142
installed by default, using this command:
127143

128144
.. code-block:: console
129145
130-
$ aqt install-qt linux desktop 6.2.0 gcc_64 --external 7z
146+
$ aqt install-qt linux desktop 6.8.0 linux_gcc_64 --external 7z
131147
132148
.. _py7zr: https://pypi.org/project/py7zr/
133149
.. _p7zip: https://p7zip.sourceforge.net/
@@ -138,8 +154,8 @@ Changing the output directory
138154

139155
By default, ``aqt`` will install all of the Qt packages into the current
140156
working directory, in the subdirectory ``./<Qt version>/<arch>/``.
141-
For example, if we install Qt 6.2.0 for Windows desktop with arch ``win64_mingw81``,
142-
it would end up in ``./6.2.0/win64_mingw81``.
157+
For example, if we install Qt 6.8.0 for Windows desktop with arch ``win64_mingw``,
158+
it would end up in ``./6.8.0/win64_mingw``.
143159

144160
If you would prefer to install it to another location, you
145161
will need to use the ``-O`` or ``--outputdir`` flag.
@@ -152,7 +168,7 @@ you may use this command:
152168
.. code-block:: doscon
153169
154170
C:\> mkdir Qt
155-
C:\> aqt install-qt --outputdir c:\Qt windows desktop 6.2.0 win64_mingw81
171+
C:\> aqt install-qt --outputdir c:\Qt windows desktop 6.8.0 win64_mingw
156172
157173
158174
Installing Modules
@@ -294,7 +310,9 @@ You can do this automatically with the ``--autodesktop`` flag:
294310
Installing Qt for WASM
295311
----------------------
296312

297-
To find out how to install Qt for WASM, we will need to use the ``wasm_32`` architecture.
313+
To find out how to install Qt for WASM, we will need to use the ``wasm_32`` architecture for Qt versions <= 6.4.*
314+
For Qt versions 6.5.* and 6.6.*, we will need to use the ``wasm_singlethread`` or ``wasm_multithread`` architectures.
315+
For Qt version >= 6.7.*, we will need to use the host ``all_os``, the target ``wasm``, and the ``wasm_singlethread`` or ``wasm_multithread`` architectures.
298316
We can find out whether or not that architecture is available for our version of Qt with the
299317
``--arch`` flag.
300318

@@ -304,11 +322,17 @@ We can find out whether or not that architecture is available for our version of
304322
win64_mingw81 win64_msvc2019_64
305323
$ python -m aqt list-qt windows desktop --arch 6.2.0
306324
win64_mingw81 win64_msvc2019_64 win64_msvc2019_arm64 wasm_32
325+
$ python -m aqt list-qt windows desktop --arch 6.5.0
326+
win64_mingw win64_msvc2019_64 win64_msvc2019_arm64 wasm_singlethread wasm_multithread
327+
$ python -m aqt list-qt all_os wasm --arch 6.8.0
328+
wasm_singlethread wasm_multithread
329+
307330
308331
Not every version of Qt supports WASM. This command shows us that we cannot use WASM with Qt 6.1.3.
309332

310-
Please note that the WASM architecture for Qt 6.5.0+ changed from ``wasm_32`` to ``wasm_singlethread`` and
311-
``wasm_multithread``. Always use ``aqt list-qt`` to check what architectures are available for the desired version of Qt.
333+
Please note that the WASM architecture for Qt 6.5.* and Qt 6.6.* changed from ``wasm_32`` to ``wasm_singlethread`` and
334+
``wasm_multithread``. For Qt 6.7.* and above, you will also need to use the host ``all_os`` and target ``wasm``.
335+
Always use ``aqt list-qt`` to check what architectures are available for the desired version of Qt.
312336

313337
We can check the modules available as before:
314338

@@ -331,6 +355,8 @@ You can do this automatically with the ``--autodesktop`` flag:
331355
.. code-block:: console
332356
333357
$ aqt install-qt linux desktop 6.2.0 wasm_32 -m qtcharts qtnetworkauth --autodesktop
358+
$ aqt install-qt linux desktop 6.6.0 wasm_singlethread -m qtcharts qtnetworkauth --autodesktop
359+
$ aqt install-qt all_os wasm 6.8.0 wasm_multithread -m qtcharts qtnetworkauth --autodesktop
334360
335361
336362
Installing Docs

0 commit comments

Comments
 (0)