aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-12-09 10:34:28 +0100
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2020-12-09 11:23:14 +0000
commit592a716369d2cdacb423b8abc29045b1d1535991 (patch)
treeee5299223642aa7f24e664246115ab206a6e24f2
parentb12c71b9c1fd9723f30329dc8c16a63d4e5eb80b (diff)
Add a small PySide2 porting guide
Change-Id: Id030c46e56b24df02e8b946768c3deb1e09427a1 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com>
-rw-r--r--sources/pyside6/doc/contents.rst1
-rw-r--r--sources/pyside6/doc/index.rst4
-rw-r--r--sources/pyside6/doc/porting_from2.rst29
3 files changed, 34 insertions, 0 deletions
diff --git a/sources/pyside6/doc/contents.rst b/sources/pyside6/doc/contents.rst
index 6d0b25fb7..bb849ce6c 100644
--- a/sources/pyside6/doc/contents.rst
+++ b/sources/pyside6/doc/contents.rst
@@ -6,6 +6,7 @@
quickstart.rst
gettingstarted.rst
+ porting_from2.rst
api.rst
tutorials/index.rst
examples/index.rst
diff --git a/sources/pyside6/doc/index.rst b/sources/pyside6/doc/index.rst
index f45f872d5..212df0185 100644
--- a/sources/pyside6/doc/index.rst
+++ b/sources/pyside6/doc/index.rst
@@ -21,11 +21,15 @@
be used to expose C++ projects to Python, and a Python module with
some utility functions.
+`Porting from PySide2 to PySide6`_ provides information on porting existing PySide2
+applications.
+
This project is available under the LGPLv3/GPLv3 and the `Qt commercial license`_.
.. _Qt: https://doc.qt.io
.. _PySide6: quickstart.html
.. _`Qt commercial license`: https://www.qt.io/licensing/
+.. _`Porting from PySide2 to PySide6`: porting_from2.html
diff --git a/sources/pyside6/doc/porting_from2.rst b/sources/pyside6/doc/porting_from2.rst
new file mode 100644
index 000000000..c5ead6e05
--- /dev/null
+++ b/sources/pyside6/doc/porting_from2.rst
@@ -0,0 +1,29 @@
+Porting applications from PySide2 to PySide6
+********************************************
+
+Qt for Python 6.0.0 initially ships with the essential
+`Modules <https://doc.qt.io/qt-6/qtmodules.html>`_ and some
+add-ons (Qt Concurrent, Qt Help, Qt OpenGL, Qt Print Support
+Qt Quick Widgets, Qt SQL, Qt SVG, Qt UI Tools and Qt XML).
+More modules will follow in subsequent releases as they
+are added to Qt.
+
+The first thing to do when porting applications is to replace the
+import statements:
+
+::
+
+ from PySide2.QtWidgets import QApplication...
+ from PySide2 import QtCore
+
+needs to be changed to:
+
+::
+
+ from PySide6.QtWidgets import QApplication...
+ from PySide6 import QtCore
+
+Then, the code base needs to be checked for usage of deprecated API and adapted
+accordingly. More information can be found in the
+`Porting to Qt 6 <https://doc.qt.io/qt-6/portingguide.html>`_ Guide
+and the `Qt 6.0 Documentation <https://doc.qt.io/qt-6/index.html>`_ .