aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2022-09-12 10:37:08 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-09-12 20:00:11 +0000
commita004d5a301402f4500612863b8220622ee5d87ac (patch)
treefd33618697fb035266d320a7a2bc64e9d05b73bc
parented0a7534dafc3ead62fe69e3d06dcebbf6cafaf1 (diff)
Update documentation
- Use version 6.2 - Delete obsolete paragraphs - Fix some errors Change-Id: I0c86f013fb3ad21a4cc7c5d490a9f129e80f3540 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 276d60b71a72a548340e6684a21fd122c4365ed9) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--sources/pyside6/doc/gettingstarted-linux.rst8
-rw-r--r--sources/pyside6/doc/gettingstarted-macOS.rst12
-rw-r--r--sources/pyside6/doc/gettingstarted-windows.rst12
-rw-r--r--sources/pyside6/doc/gettingstarted.rst12
-rw-r--r--sources/pyside6/doc/porting_from2.rst18
-rw-r--r--sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst2
6 files changed, 26 insertions, 38 deletions
diff --git a/sources/pyside6/doc/gettingstarted-linux.rst b/sources/pyside6/doc/gettingstarted-linux.rst
index 900da999e..d32412fdf 100644
--- a/sources/pyside6/doc/gettingstarted-linux.rst
+++ b/sources/pyside6/doc/gettingstarted-linux.rst
@@ -46,14 +46,14 @@ Cloning the official repository can be done by::
Checking out the version that we want to build, for example 6.0::
- cd pyside-setup && git checkout 6.0
+ cd pyside-setup && git checkout 6.2
Install the general dependencies::
pip install -r requirements.txt
.. note:: Keep in mind you need to use the same version as your Qt installation.
- Additionally, :command:`git checkout -b 6.0 --track origin/6.0` could be a better option
+ Additionally, :command:`git checkout -b 6.2 --track origin/6.2` could be a better option
in case you want to work on it.
Building and Installing (setuptools)
@@ -67,11 +67,11 @@ for example, :command:`/opt/Qt/6.0.0/gcc_64/bin/qtpaths`.
Build can take a few minutes, so it is recommended to use more than one CPU core::
- python setup.py build --qtpaths=/opt/Qt/6.0.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+ python setup.py build --qtpaths=/opt/Qt/6.2.1/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
To install on the current directory, just run::
- python setup.py install --qtpaths=/opt/Qt/6.0.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+ python setup.py install --qtpaths=/opt/Qt/6.2.1/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
Building and Installing (cmake)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/sources/pyside6/doc/gettingstarted-macOS.rst b/sources/pyside6/doc/gettingstarted-macOS.rst
index 21e9af393..546902717 100644
--- a/sources/pyside6/doc/gettingstarted-macOS.rst
+++ b/sources/pyside6/doc/gettingstarted-macOS.rst
@@ -45,11 +45,11 @@ Getting PySide
Cloning the official repository can be done by::
- git clone --recursive https://code.qt.io/pyside/pyside-setup
+ git clone https://code.qt.io/pyside/pyside-setup
-Checking out the version that we want to build, for example, 6.0::
+Checking out the version that we want to build, for example, 6.2::
- cd pyside-setup && git checkout 6.0
+ cd pyside-setup && git checkout 6.2
Install the general dependencies::
@@ -61,18 +61,18 @@ Building PySide
~~~~~~~~~~~~~~~
Check your Qt installation path, to specifically use that version of qtpaths to build PySide.
-for example, ``/opt/Qt/6.0.0/gcc_64/bin/qtpaths``.
+for example, ``/opt/Qt/6.2.1/gcc_64/bin/qtpaths``.
Build can take a few minutes, so it is recommended to use more than one CPU core::
- python setup.py build --qtpaths=/opt/Qt/6.0.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+ python setup.py build --qtpaths=/opt/Qt/6.2.1/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
Installing PySide
~~~~~~~~~~~~~~~~~
To install on the current directory, just run::
- python setup.py install --qtpaths=/opt/Qt/6.0.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+ python setup.py install --qtpaths=/opt/Qt/6.2.1/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
Test installation
~~~~~~~~~~~~~~~~~
diff --git a/sources/pyside6/doc/gettingstarted-windows.rst b/sources/pyside6/doc/gettingstarted-windows.rst
index 369cb95eb..0e1f5cdfe 100644
--- a/sources/pyside6/doc/gettingstarted-windows.rst
+++ b/sources/pyside6/doc/gettingstarted-windows.rst
@@ -7,14 +7,14 @@ selected when using the online installer.
Requirements
------------
- * `MSVC2017`_ (or MSVC2019) for Python 3 on Windows,
+ * `MSVC2022`_ or (MSVC2019) for Python 3 on Windows,
* `OpenSSL`_ (optional for SSL support, Qt must have been configured using the same SSL library).
* ``sphinx`` package for the documentation (optional).
.. note:: Python 3.8.0 was missing some API required for PySide/Shiboken so it's not possible
to use it for a Windows build.
-.. _MSVC2017: https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools
+.. _MSVC2022: https://visualstudio.microsoft.com/downloads/
.. _OpenSSL: https://sourceforge.net/projects/openssl/
Building from source on Windows 10
@@ -53,11 +53,11 @@ Getting PySide
Cloning the official repository can be done by::
- git clone --recursive https://code.qt.io/pyside/pyside-setup
+ git clone https://code.qt.io/pyside/pyside-setup
-Checking out the version that we want to build, for example, 6.0::
+Checking out the version that we want to build, for example, 6.2::
- cd pyside-setup && git checkout 6.0
+ cd pyside-setup && git checkout 6.2
Install the general dependencies::
@@ -69,7 +69,7 @@ Building PySide
~~~~~~~~~~~~~~~
Check your Qt installation path, to specifically use that version of qtpaths to build PySide.
-for example, ``E:\Qt\6.0.0\msvc2019_64\bin\qtpaths.exe``.
+for example, ``C:\Qt\6.2.1\msvc2019_64\bin\qtpaths.exe``.
Build can take a few minutes, so it is recommended to use more than one CPU core::
diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst
index 2ff8e30c2..47829171b 100644
--- a/sources/pyside6/doc/gettingstarted.rst
+++ b/sources/pyside6/doc/gettingstarted.rst
@@ -94,7 +94,7 @@ Using the ``--build-tests`` option will enable us to run all the auto tests insi
python testrunner.py test > testlog.txt
.. note:: On Windows, don't forget to have qtpaths in your path
- (:command:`set PATH=E:\\\Path\\\to\\\Qt\\\6.0.0\\\msvc2019_64\\\bin;%PATH%`)
+ (:command:`set PATH=C:\\\Path\\\to\\\Qt\\\6.2.1\\\msvc2019_64\\\bin;%PATH%`)
You can also run a specific test (for example ``qpainter_test``) by running::
@@ -321,7 +321,7 @@ An example of the ``setup.py`` invocation might look like the following:
--parallel=8 --ignore-git --reuse-build --standalone --limited-api=yes \
--cmake-toolchain-file=/opt/toolchain-aarch64.cmake \
--qt-host-path=/opt/Qt/6.3.0/gcc_64 \
- --plat-name=linux_aarch64 \
+ --plat-name=linux_aarch64
Depending on the target platform, you could use ``linux_armv7``,
``linux_aarch64``, etc.
@@ -431,7 +431,7 @@ The target executes several steps:
#. ``sphinx`` is run to produce the documentation in HTML format.
Re-running the command will not execute step 1 unless the file
-``qdoc_output/webxml/qtcore-index.webxml`` is removed from the build tree.
+``qdoc-output/webxml/qtcore-index.webxml`` is removed from the build tree.
Similarly, step 2 will not be executed unless the file ``rst/PySide6/QtCore/index.rst``
is removed.
@@ -457,12 +457,6 @@ Qt Assistant::
assistant -register PySide.qch
-.. note:: Qt Assistant renders the QCH content using the QTextBrowser backend, which supports
- a subset of the CSS styles, However, Qt Creator offers an alternative litehtml-based
- backend, which offers better browsing experience. At the moment, this is not the default
- backend, so you have to select the litehtml backend
- explicitly under the ``General`` tab in ``Qt Creator >> Tools >> Options >> Help``.
-
Using the internal tools
------------------------
diff --git a/sources/pyside6/doc/porting_from2.rst b/sources/pyside6/doc/porting_from2.rst
index aa3e41780..2d5c8414f 100644
--- a/sources/pyside6/doc/porting_from2.rst
+++ b/sources/pyside6/doc/porting_from2.rst
@@ -4,23 +4,17 @@ Porting Applications from PySide2 to PySide6
Module Availability
-------------------
-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 3D, 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.
-
-For Qt for Python 6.1, Active Qt, Qt Charts, Qt Data Visualization,
-Qt StateMachine and Qt SCXML are planned.
+Qt for Python 6.2.0 provides all modules planned for inclusion in Qt 6.
Module-Level Changes
--------------------
-* *Qt Quick Controls 1* have been removed.
+* The modules *QtMacExtras*, *Qt Quick Controls 1*, *QtWinExtras*,
+ *QtXmlPatterns* and *QtX11Extras* have been removed.
* ``QStateMachine`` and related classes have been extracted to a new
*QtStateMachine* module.
+* The modules *QtWebKit* and *QtWebKitWidgets* have been replaced by the new
+ *QtWebEngineCore*, *QtWebEngineQuick* and *QtWebEngineWidgets* modules.
* ``QXmlReader`` and related classes (*SAX API*) have been removed.
* The content of the *QtOpenGL* module has been replaced. The class
``QGLWidget`` and related classes (``QGLContext``, ``QGLFunctions``,
@@ -97,4 +91,4 @@ accordingly. For example:
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>`_ .
+and the `Qt 6.2 Documentation <https://doc.qt.io/qt-6/index.html>`_ .
diff --git a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst
index 470b4ab70..d22075812 100644
--- a/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst
+++ b/sources/pyside6/doc/tutorials/basictutorial/signals_and_slots.rst
@@ -185,7 +185,7 @@ the different functionality.
speak = Signal((int,), (str,))
def __init__(self, parent=None):
- super().__init__(self, parent)
+ super().__init__(parent)
self.speak[int].connect(self.say_something)
self.speak[str].connect(self.say_something)