Mirrors/aqtinstall
1
0
Fork 0
mirror of https://github.com/miurahr/aqtinstall.git synced 2025-12-17 04:34:37 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add docs clarifying list-doc and install-doc (#754)

Browse Source 
* Add docs clarifying list-doc and install-doc

Fixes https://github.com/miurahr/aqtinstall/issues/753

* Update docs/getting_started.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

* Update docs/getting_started.rst

Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>

---------

Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
This commit is contained in:
Andrew Wason
2024-01-23 00:05:21 -05:00
committed by GitHub
parent e771fbf57e
commit 61e18c869f
1 changed files with 48 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/getting_started.rst
View File

@@ -317,6 +317,54 @@ You can do this automatically with the ``--autodesktop`` flag:
$ aqt install-qt linux desktop 6.2.0 wasm_32 -m qtcharts qtnetworkauth --autodesktop
Installing Docs
---------------
The :ref:`aqt list-doc <list-doc command>` command lists documentation
archives for a given Qt version:
.. code-block:: console
$ aqt list-doc mac 6.6.1
qdoc qmake qt5 qtassistant qtcmake qtconcurrent qtcore qtdbus qtdesigner
qtdistancefieldgenerator qtdoc qtgui qthelp qtlabsplatform qtlinguist qtnetwork
qtopengl qtplatformintegration qtprintsupport qtqml qtqmlcore qtqmlmodels qtqmltest
qtqmlworkerscript qtqmlxmllistmodel qtquick qtquickcontrols qtquickdialogs qtsql
qtsvg qttestlib qtuitools qtwaylandcompositor qtwidgets qtxml
All of the above archives will be installed when you run ``aqt install-doc mac 6.6.1``
without any other flags or arguments.
You can select a subset of them with the ``--archives`` flag.
The ``--modules`` flag lists additional documentation modules that can be installed:
.. code-block:: console
$ aqt list-doc mac 6.6.1 --modules
qt3d qt5compat qtactiveqt qtbluetooth qtcharts qtdatavis3d qtgraphs qtgrpc qthttpserver
qtimageformats qtlocation qtlottie qtmultimedia qtnetworkauth qtnfc qtpdf qtpositioning
qtquick3d qtquick3dphysics qtquickeffectmaker qtquicktimeline qtremoteobjects qtscxml
qtsensors qtserialbus qtserialport qtshadertools qtspeech qtvirtualkeyboard qtwebchannel
qtwebengine qtwebsockets qtwebview
The ``--archives`` and ``--modules`` flags can be used together.
For example, to only install the docs for ``qtquick`` and ``qt3d``,
use the :ref:`aqt install-doc <install-doc command>` command like this:
.. code-block:: console
$ aqt install-doc mac 6.6.1 --archives qtquick --modules qt3d
INFO : Downloading qt3d...
INFO : Downloading qtquick...
INFO : Redirected: qt.mirror.constant.com
INFO : Redirected: qt.mirror.constant.com
INFO : Finished installation of qt3d-documentation.tar.xz in 1.51932292
INFO : Finished installation of qtquick-documentation.tar.xz in 2.63531679
INFO : Finished installation
INFO : Time elapsed: 4.00115146 second
Installing Tools
----------------