aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2021-03-19 13:15:59 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-03-22 20:11:31 +0000
commit12520af904a08d73d2a71965ae1506d3f7aa862d (patch)
tree83a576ac4d5c6cc44804f1fc9b140fb0edf5ac36
parentfe29625e6ee1167b02612b3e4c3d5fa9ad7a3295 (diff)
Improve deployment documentation
Extend the table by the Qt version. Add some chapter on Qt 6 support. Add some description for py2exe. Task-number: PYSIDE-1112 Change-Id: Ic3a9fb76d9c13017a107f083da4c7ed326d64e5c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 80aec29aca246f1f67a4f8c453b49f1eadfee6fd) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--sources/pyside6/doc/deployment-briefcase.rst5
-rw-r--r--sources/pyside6/doc/deployment-py2exe.rst16
-rw-r--r--sources/pyside6/doc/deployment-pyinstaller.rst18
-rw-r--r--sources/pyside6/doc/deployment.rst15
4 files changed, 54 insertions, 0 deletions
diff --git a/sources/pyside6/doc/deployment-briefcase.rst b/sources/pyside6/doc/deployment-briefcase.rst
index 230365804..471ae6251 100644
--- a/sources/pyside6/doc/deployment-briefcase.rst
+++ b/sources/pyside6/doc/deployment-briefcase.rst
@@ -9,6 +9,11 @@
For more details, see the `official documentation <https://briefcase.readthedocs.io/en/latest/index.html>`_.
+Status of Qt 6 Support
+======================
+
+As of March 2021, Qt 6 is not supported yet.
+
Preparation
===========
diff --git a/sources/pyside6/doc/deployment-py2exe.rst b/sources/pyside6/doc/deployment-py2exe.rst
new file mode 100644
index 000000000..24d260d71
--- /dev/null
+++ b/sources/pyside6/doc/deployment-py2exe.rst
@@ -0,0 +1,16 @@
+|project| & py2exe
+##################
+
+Deploying an application using py2exe requires writing a small `setup.py` file.
+It is explained in the `Tutorial <http://www.py2exe.org/index.cgi/Tutorial>`_.
+
+py2exe is not generally aware of Qt. It merely copies the dependent libraries
+of the application to the `dist` directory, so, the plugins, QML imports
+and translations of Qt are missing.
+
+The latter need to be copied manually after running py2exe.
+This can be achieved by running the `windeployqt` tool
+from the Qt SDK on the Qt libraries present in the `dist` directory,
+for example:
+
+ windeployqt dist\\Qt6Widgets.dll
diff --git a/sources/pyside6/doc/deployment-pyinstaller.rst b/sources/pyside6/doc/deployment-pyinstaller.rst
index 5771f0bec..6589c614d 100644
--- a/sources/pyside6/doc/deployment-pyinstaller.rst
+++ b/sources/pyside6/doc/deployment-pyinstaller.rst
@@ -7,6 +7,24 @@ compatible with 3rd-party Python modules, such as |pymodname|.
For more details, see the `official documentation <https://www.pyinstaller.org/documentation.html>`_.
+Status of Qt 6 Support
+======================
+
+As of March 2021, Qt 6 is not supported yet. PyInstaller is unable to properly
+deploy Qt; the Qt plugins are not copied. With that, using `--onefile` is not
+possible.
+
+It is possible to use PyInstaller for the non `--onefile` case though by
+manually copying the Qt plugins, QML imports and translations into
+the dist directory after running PyInstaller.
+
+On Windows, this can be achieved by running the `windeployqt` tool
+from the Qt SDK on the Qt libraries present in the `dist` directory, for
+example:
+
+ windeployqt dist\\app\\Qt6Widgets.dll
+
+
Preparation
===========
diff --git a/sources/pyside6/doc/deployment.rst b/sources/pyside6/doc/deployment.rst
index 550273c22..7fb6b5eb7 100644
--- a/sources/pyside6/doc/deployment.rst
+++ b/sources/pyside6/doc/deployment.rst
@@ -42,6 +42,8 @@ The following table summarizes the platform support for those packaging tools:
<tr>
<th class="head">Name</th>
<th class="head">License</th>
+ <th class="head">Qt 6</th>
+ <th class="head">Qt 5</th>
<th class="head">Linux</th>
<th class="head">macOS</th>
<th class="head">Windows</th>
@@ -51,6 +53,8 @@ The following table summarizes the platform support for those packaging tools:
<tr>
<td><p>fbs</p></td>
<td><p>GPL</p></td>
+ <td></td>
+ <td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
@@ -58,6 +62,8 @@ The following table summarizes the platform support for those packaging tools:
<tr>
<td><p>PyInstaller</p></td>
<td><p>GPL</p></td>
+ <td><p style="color: green;">partial</p></td>
+ <td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
@@ -68,10 +74,14 @@ The following table summarizes the platform support for those packaging tools:
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
</tr>
<tr>
<td><p>py2exe</p></td>
<td><p>MIT</p></td>
+ <td><p style="color: green;">partial</p></td>
+ <td><p style="color: green;">partial</p></td>
<td><p style="color: red;">no</p></td>
<td><p style="color: red;">no</p></td>
<td><p style="color: green;">yes</p></td>
@@ -79,6 +89,8 @@ The following table summarizes the platform support for those packaging tools:
<tr>
<td><p>py2app</p></td>
<td><p>MIT</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
<td><p style="color: red;">no</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: red;">no</p></td>
@@ -86,6 +98,8 @@ The following table summarizes the platform support for those packaging tools:
<tr>
<td><p>briefcase</p></td>
<td><p>BSD3</p></td>
+ <td><p style="color: red;">no</p></td>
+ <td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
<td><p style="color: green;">yes</p></td>
@@ -119,3 +133,4 @@ Here's a set of tutorials on how to use these tools:
deployment-pyinstaller.rst
deployment-cxfreeze.rst
deployment-briefcase.rst
+ deployment-py2exe.rst