aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2023-10-05 16:05:39 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-10-11 08:11:28 +0000
commit6a50ae5ff55ed81885ce0dd4bbdcc3217f553fef (patch)
tree3739541874fdb5d4ac59b85f584671c7287c3897
parent3c1ef7894ae3119da7d67f778b53a8f709583da1 (diff)
Desktop Deployment: Update docs
Task-number: PYSIDE-1612 Change-Id: I825b3cf13aba173313bcbef74d2007d3ca4c12b0 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit 23d21957f59b12250164c188b21e2027a1c67643) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 8e10650bd770b2734f335fe7f3b2fa4f0c6bab92)
-rw-r--r--sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
index 3c4569aff..d64c87b34 100644
--- a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
+++ b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
@@ -70,7 +70,10 @@ two folds:
gives the user more control of the deployment process. For example, when you decide to exclude
more QML plugins, or want to include more Nuitka options into your executable.
-The various parameters controlled by this file are:
+This file is also used by the ``pyside6-android-deploy`` tool as a configuration file. The advantage
+here is that you can have one single file to control deployment to all platforms.
+
+The relevant parameters for ``pyside6-deploy`` are:
**app**
* ``title``: The name of the application
@@ -81,6 +84,7 @@ The various parameters controlled by this file are:
.pyproject <https://doc.qt.io/qtforpython-6/faq/typesoffiles.html
#qt-creator-python-project-file-pyproject>`_ file. Such a file makes sure that the deployment
process never considers unnecessary files when bundling the executable.
+ * ``exec_directory``: The directory where the final executable is generated.
**python**
* ``python_path``: Path to the Python executable. It is recommended to run the deployment