aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShyamnath Premnadh <[email protected]>2023-10-05 16:05:39 +0200
committerShyamnath Premnadh <[email protected]>2023-10-10 13:18:37 +0200
commit23d21957f59b12250164c188b21e2027a1c67643 (patch)
treeb511c1e323dcd2c966e7cab6148614f866974875
parent9b2aa20bc84b17185f6d2e1f5966ef7baff99c4e (diff)
Desktop Deployment: Update docs
Task-number: PYSIDE-1612 Pick-to: 6.6 6.5 Change-Id: I825b3cf13aba173313bcbef74d2007d3ca4c12b0 Reviewed-by: Friedemann Kleint <[email protected]>
-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