diff options
author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2023-02-16 12:14:08 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-02-16 14:28:14 +0000 |
commit | 7e4f907f6bab2240e477d93a8e516705c58dc40f (patch) | |
tree | 20b99089d83600799a98dbac9b718fbdae7b7d97 | |
parent | 7042dd9eb5253bb0da461ce714dae99db142fd7c (diff) |
doc: update versions and broken links
Change-Id: Ib6223ac742b7c7777d2b6110a395b508e5031a75
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
(cherry picked from commit 7d1cbfe817ea2cef7a9c8dd3a9e5df188675835e)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | sources/pyside6/doc/considerations.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/deployment/deployment-cxfreeze.rst | 5 | ||||
-rw-r--r-- | sources/pyside6/doc/deployment/deployment-fbs.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/deployment/deployment-pyinstaller.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/gettingstarted/index.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/gettingstarted/linux.rst | 12 | ||||
-rw-r--r-- | sources/pyside6/doc/gettingstarted/macOS.rst | 10 | ||||
-rw-r--r-- | sources/pyside6/doc/gettingstarted/windows.rst | 6 | ||||
-rw-r--r-- | sources/pyside6/doc/quickstart.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/expenses/expenses.rst | 4 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst | 2 |
11 files changed, 25 insertions, 24 deletions
diff --git a/sources/pyside6/doc/considerations.rst b/sources/pyside6/doc/considerations.rst index 6f4a059a2..680d70340 100644 --- a/sources/pyside6/doc/considerations.rst +++ b/sources/pyside6/doc/considerations.rst @@ -10,7 +10,7 @@ One of the goals of |pymodname| is to be API compatible with PyQt, with certain exceptions. The latest considerations and known issues will be also reported -in the `wiki <https://wiki.qt.io/Qt_for_Python/Considerations>`_. +in the :ref:`developer-notes`. __hash__() function return value ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/sources/pyside6/doc/deployment/deployment-cxfreeze.rst b/sources/pyside6/doc/deployment/deployment-cxfreeze.rst index 681dcf315..612ca5a32 100644 --- a/sources/pyside6/doc/deployment/deployment-cxfreeze.rst +++ b/sources/pyside6/doc/deployment/deployment-cxfreeze.rst @@ -8,8 +8,9 @@ platforms are Linux, macOS, Windows, FreeBSD, among others. You can read the `official documentation <https://cx-freeze.readthedocs.io/en/latest/index.html>`_ to clarify any further question, and remember to contribute to -the project by `filing issues <https://sourceforge.net/projects/cx-freeze/>`_ -if you find any, or contributing to `their development <https://bitbucket.org/anthony_tuininga/cx_freeze/src>`_. +the project by `filing issues +<https://github.com/marcelotduarte/cx_Freeze/issues>`_ +if you find any, or contributing to `their development <https://github.com/marcelotduarte/cx_Freeze>`_. Preparation =========== diff --git a/sources/pyside6/doc/deployment/deployment-fbs.rst b/sources/pyside6/doc/deployment/deployment-fbs.rst index c2a2397d2..1098ccd4e 100644 --- a/sources/pyside6/doc/deployment/deployment-fbs.rst +++ b/sources/pyside6/doc/deployment/deployment-fbs.rst @@ -83,7 +83,7 @@ After the process completes, you see a message stating the location of your exec example:: Done. You can now run `target/MyApp/MyApp`. If that doesn't work, see - https://build-system.fman.io/troubleshooting. + https://build-system.fman.io/troubleshooting Now, you can try to run the application. The result is the same window as the one you saw with the diff --git a/sources/pyside6/doc/deployment/deployment-pyinstaller.rst b/sources/pyside6/doc/deployment/deployment-pyinstaller.rst index eb900bd74..8d78ddba0 100644 --- a/sources/pyside6/doc/deployment/deployment-pyinstaller.rst +++ b/sources/pyside6/doc/deployment/deployment-pyinstaller.rst @@ -5,7 +5,7 @@ stand-alone executable. This installer supports Linux, macOS, Windows, and more; and is also compatible with 3rd-party Python modules, such as |pymodname|. -For more details, see the `official documentation <https://www.pyinstaller.org/documentation.html>`_. +For more details, see the `official documentation <https://www.pyinstaller.org>`_. Status of Qt 6 Support ====================== diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst index 4b690dc51..97995fe21 100644 --- a/sources/pyside6/doc/gettingstarted/index.rst +++ b/sources/pyside6/doc/gettingstarted/index.rst @@ -4,7 +4,7 @@ Getting Started .. important:: This page is focused on building |project| **from source**. If you just want to install |pymodname|, you need to run: :command:`pip install pyside6`. - For more details, refer to our `Quick Start`_ guide. Additionally, you can check the + For more details, refer to our :ref:`quick-start` guide. Additionally, you can check the :ref:`FAQ <faq>` related to the project. .. _Quick Start: quickstart.html diff --git a/sources/pyside6/doc/gettingstarted/linux.rst b/sources/pyside6/doc/gettingstarted/linux.rst index 7d4000da2..f5ef71bae 100644 --- a/sources/pyside6/doc/gettingstarted/linux.rst +++ b/sources/pyside6/doc/gettingstarted/linux.rst @@ -44,16 +44,16 @@ Cloning the official repository can be done by:: 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.4:: - cd pyside-setup && git checkout 6.2 + cd pyside-setup && git checkout 6.4 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.2 --track origin/6.2` could be a better option + Additionally, :command:`git checkout -b 6.4 --track origin/6.4` could be a better option in case you want to work on it. Building and Installing (setuptools) @@ -63,15 +63,15 @@ The `setuptools` approach uses the `setup.py` file to execute the build, install, and packaging steps. Check your Qt installation path, to specifically use that version of qtpaths to build PySide. -for example, :command:`/opt/Qt/6.0.0/gcc_64/bin/qtpaths`. +for example, :command:`/opt/Qt/6.4.2/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.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python setup.py build --qtpaths=/opt/Qt/6.4.2/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.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python setup.py install --qtpaths=/opt/Qt/6.4.2/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 7c3784b02..9d57c7ceb 100644 --- a/sources/pyside6/doc/gettingstarted/macOS.rst +++ b/sources/pyside6/doc/gettingstarted/macOS.rst @@ -47,9 +47,9 @@ Cloning the official repository can be done by:: git clone https://code.qt.io/pyside/pyside-setup -Checking out the version that we want to build, for example, 6.2:: +Checking out the version that we want to build, for example, 6.4:: - cd pyside-setup && git checkout 6.2 + cd pyside-setup && git checkout 6.4 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.4.0/gcc_64/bin/qtpaths``. +for example, ``/opt/Qt/6.4.2/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.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python setup.py build --qtpaths=/opt/Qt/6.4.2/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.4.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + python setup.py install --qtpaths=/opt/Qt/6.4.2/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 c80d0176c..dd266c8f4 100644 --- a/sources/pyside6/doc/gettingstarted/windows.rst +++ b/sources/pyside6/doc/gettingstarted/windows.rst @@ -55,9 +55,9 @@ Cloning the official repository can be done by:: git clone https://code.qt.io/pyside/pyside-setup -Checking out the version that we want to build, for example, 6.2:: +Checking out the version that we want to build, for example, 6.4:: - cd pyside-setup && git checkout 6.2 + cd pyside-setup && git checkout 6.4 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, ``C:\Qt\6.4.0\msvc2019_64\bin\qtpaths.exe``. +for example, ``C:\Qt\6.4.2\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/quickstart.rst b/sources/pyside6/doc/quickstart.rst index fdb902186..ebe8a4f61 100644 --- a/sources/pyside6/doc/quickstart.rst +++ b/sources/pyside6/doc/quickstart.rst @@ -54,7 +54,7 @@ Installation * It is also possible to install a specific snapshot from our servers. To do so, you can use the following command:: - pip install --index-url=https://download.qt.io/snapshots/ci/pyside/6.0.0/latest pyside6 --trusted-host download.qt.io + pip install --index-url=https://download.qt.io/snapshots/ci/pyside/6.4/latest pyside6 --trusted-host download.qt.io .. note:: Starting with 6.4.3, PySide6 can be used from inside a conda environment, but any manual changes you make to the qt.conf file will be diff --git a/sources/pyside6/doc/tutorials/expenses/expenses.rst b/sources/pyside6/doc/tutorials/expenses/expenses.rst index c8ae5c034..335f1efcd 100644 --- a/sources/pyside6/doc/tutorials/expenses/expenses.rst +++ b/sources/pyside6/doc/tutorials/expenses/expenses.rst @@ -20,9 +20,9 @@ The requirements: (`QPushButton <https://doc.qt.io/qtforpython/PySide6/QtWidgets/QPushButton.html>`_). * A verification step to avoid invalid data entry. * A chart to visualize the expense data - (`QChart <https://doc.qt.io/qtforpython/PySide6/QtCharts/QtCharts.QChart.html>`_) that will + (`QChart <https://doc.qt.io/qtforpython/PySide6/QtCharts/QChart.html>`_) that will be embedded in a chart view - (`QChartView <https://doc.qt.io/qtforpython/PySide6/QtCharts/QtCharts.QChartView.html>`_). + (`QChartView <https://doc.qt.io/qtforpython/PySide6/QtCharts/QChartView.html>`_). Empty window ------------ diff --git a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst index b68a3686e..b77648d6a 100644 --- a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst +++ b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst @@ -17,7 +17,7 @@ Before you begin, install the following prerequisites: * The `PySide6 <https://pypi.org/project/PySide6/>`_ Python packages. * Qt Creator v4.9 beta1 or later from `https://download.qt.io - <https://download.qt.io/snapshots/qtcreator/4.9/4.9.0-beta1/>`_. + <https://download.qt.io/snapshots/qtcreator/>`_. The following step-by-step instructions guide you through application |