aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst')
-rw-r--r--sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
index ff5026e65..8c5af3db4 100644
--- a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
+++ b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
@@ -10,6 +10,12 @@ compiles your Python code to C code, and links with libpython to produce the fin
The final executable produced has a ``.exe`` suffix on Windows, ``.bin`` on Linux and ``.app`` on
macOS.
+.. note:: Although using a virtual environment for Python is recommended for ``pyside6-deploy``, do
+ not add the virtual environment to the application directory you are trying to deploy.
+ ``pyside6-deploy`` will try to package this venv folder and will eventually fail.
+
+.. _how_pysidedeploy:
+
How to use it?
==============
@@ -62,6 +68,8 @@ parameters of the deployment process. The file has multiple sections, with each
multiple keys (parameters being controlled) assigned to a value. The advantages of such a file are
two folds:
+.. _pysidedeployspec_advantages:
+
#. Using the command line, you can control the deployment parameters without specifying them each
time. It is saved permanently in a file, and any subsequent runs much later in time
would enable the user to be aware of their last deployment parameters.