Documentation: Update versions for Qt 6.8

Task-number: PYSIDE-2620 Change-Id: Iff5ac3c8281893adfa0ba3cbd64936fd7c4d6257 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
author: Friedemann Kleint <Friedemann.Kleint@qt.io> 2024-05-28 08:48:48 +0200
committer: Friedemann Kleint <Friedemann.Kleint@qt.io> 2024-05-28 13:08:32 +0200
commit: ae457aeeba5d78b4d5e451e8242c686a0f442b12 (patch)
tree: 6e07ad0e0b4598830a355249a38bba1e4ece5333 /sources/pyside6/doc/gettingstarted
parent: 36e2078d25e09c360e150dbbab4c20a4f03552c7 (diff)
4 files changed, 34 insertions, 22 deletions
diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst
index 9d36061ad..51d8bea26 100644
--- a/sources/pyside6/doc/gettingstarted/index.rst
+++ b/sources/pyside6/doc/gettingstarted/index.rst
@@ -18,10 +18,10 @@ you might get them with ``brew``, and on **Windows** you can download the instal
 website.
 
 * **Python**: 3.9+ `[official Python website] <https://www.python.org/downloads/>`_
-* **Qt:** 6.4+ `[online installer] <https://download.qt.io/official_releases/online_installers/>`_
+* **Qt:** 6.8+ `[online installer] <https://download.qt.io/official_releases/online_installers/>`_
 * **CMake:** 3.18+ `[official CMake website] <https://cmake.org/download/>`_
 * **Git:** 2.0+. `[official Git website] <https://git-scm.com/downloads>`_
-* **libclang:** The libclang library, recommended: version 10 for 6.0+.
+* **libclang:** The libclang library, recommended: version 16+ for 6.8+.
   Prebuilt versions for each OS can be `downloaded here`_.
 * Check the `Supported Platforms of Qt`_
 
diff --git a/sources/pyside6/doc/gettingstarted/linux.rst b/sources/pyside6/doc/gettingstarted/linux.rst
index 912105ef8..eb1b5869d 100644
--- a/sources/pyside6/doc/gettingstarted/linux.rst
+++ b/sources/pyside6/doc/gettingstarted/linux.rst
@@ -30,12 +30,12 @@ Setting up CLANG
 
 If you don't have libclang already in your system, you can download from the Qt servers::
 
-    wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_140-based-linux-Rhel8.2-gcc9.2-x86_64.7z
+    wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_18.1.5-based-linux-Rhel8.6-gcc10.3-x86_64.7z
 
 Extract the files, and leave it on any desired path, and set the environment
 variable required::
 
-    7z x libclang-release_140-based-linux-Rhel8.2-gcc9.2-x86_64.7z
+    7z x libclang-release_18.1.5-based-linux-Rhel8.6-gcc10.3-x86_64.7z
     export LLVM_INSTALL_DIR=$PWD/libclang
 
 Getting the source
@@ -45,16 +45,20 @@ 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.5::
+Checking out the version that we want to build, for example 6.8::
 
-    cd pyside-setup && git checkout 6.5
+    cd pyside-setup && git checkout 6.8
 
 Install the general dependencies::
 
     pip install -r requirements.txt
 
+For building the documentation::
+
+    pip install -r requirements-doc.txt
+
 .. note:: Keep in mind you need to use the same version as your Qt installation.
-          Additionally, :command:`git checkout -b 6.5 --track origin/6.5` could be a better option
+          Additionally, :command:`git checkout -b 6.8 --track origin/6.8` could be a better option
           in case you want to work on it.
 
 Building and Installing (setuptools)
@@ -64,15 +68,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.5.0/gcc_64/bin/qtpaths`.
+for example, :command:`/opt/Qt/6.8.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.5.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+    python setup.py build --qtpaths=/opt/Qt/6.8.0/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.5.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+    python setup.py install --qtpaths=/opt/Qt/6.8.0/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 ff457a4e2..accffbe92 100644
--- a/sources/pyside6/doc/gettingstarted/macOS.rst
+++ b/sources/pyside6/doc/gettingstarted/macOS.rst
@@ -34,12 +34,12 @@ Setting up CLANG
 
 If you don't have libclang already in your system, you can download from the Qt servers::
 
-    wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_140-based-macos-universal.7z
+    wget https://download.qt.io/development_releases/prebuilt/libclang/libclang-release_18.1.5-based-macos-universal.7z
 
 Extract the files, and leave it on any desired path, and set the environment
 variable required::
 
-    7z x libclang-release_140-based-macos-universal.7z
+    7z x libclang-release_18.1.5-based-macos-universal.7z
     export LLVM_INSTALL_DIR=$PWD/libclang
 
 Getting PySide
@@ -49,32 +49,36 @@ 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.5::
+Checking out the version that we want to build, for example, 6.8::
 
-    cd pyside-setup && git checkout 6.5
+    cd pyside-setup && git checkout 6.8
 
 Install the general dependencies::
 
     pip install -r requirements.txt
 
+For building the documentation::
+
+    pip install -r requirements-doc.txt
+
 .. note:: Keep in mind you need to use the same version as your Qt installation
 
 Building PySide
 ~~~~~~~~~~~~~~~
 
 Check your Qt installation path, to specifically use that version of qtpaths to build PySide.
-for example, ``/opt/Qt/6.5.0/gcc_64/bin/qtpaths``.
+for example, ``/opt/Qt/6.8.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.5.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+    python setup.py build --qtpaths=/opt/Qt/6.8.0/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.5.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8
+    python setup.py install --qtpaths=/opt/Qt/6.8.0/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 f688acd90..4451bb1fd 100644
--- a/sources/pyside6/doc/gettingstarted/windows.rst
+++ b/sources/pyside6/doc/gettingstarted/windows.rst
@@ -7,7 +7,7 @@ selected when using the online installer.
 Requirements
 ------------
 
-* `MSVC2022`_ or (MSVC2019) for Python 3 on Windows,
+* `MSVC2022`_ 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).
 * Check the platform dependencies of `Qt for Windows`_.
@@ -38,7 +38,7 @@ Setting up CLANG
 
 libclang can be downloaded from the
 `Qt servers <https://download.qt.io/development_releases/prebuilt/libclang>`_.
-for example, ``libclang-release_140-based-windows-vs2019_64.7z``.
+for example, ``libclang-release_18.1.5-based-windows-vs2019_64.7z``.
 
 Note that from version 12 onwards, the prebuilt Windows binaries from
 `LLVM <https://www.llvm.org>`_ no longer contain CMake configuration files; so
@@ -57,21 +57,25 @@ 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.5::
+Checking out the version that we want to build, for example, 6.8::
 
-    cd pyside-setup && git checkout 6.5
+    cd pyside-setup && git checkout 6.8
 
 Install the general dependencies::
 
     pip install -r requirements.txt
 
+For building the documentation::
+
+    pip install -r requirements-doc.txt
+
 .. note:: Keep in mind you need to use the same version as your Qt installation
 
 Building PySide
 ~~~~~~~~~~~~~~~
 
 Check your Qt installation path, to specifically use that version of qtpaths to build PySide.
-for example, ``C:\Qt\6.5.0\msvc2019_64\bin\qtpaths.exe``.
+for example, ``C:\Qt\6.8.0\msvc2019_64\bin\qtpaths.exe``.
 
 Build can take a few minutes, so it is recommended to use more than one CPU core::
author	Friedemann Kleint <Friedemann.Kleint@qt.io>	2024-05-28 08:48:48 +0200
committer	Friedemann Kleint <Friedemann.Kleint@qt.io>	2024-05-28 13:08:32 +0200
commit	ae457aeeba5d78b4d5e451e8242c686a0f442b12 (patch)
tree	6e07ad0e0b4598830a355249a38bba1e4ece5333 /sources/pyside6/doc/gettingstarted
parent	36e2078d25e09c360e150dbbab4c20a4f03552c7 (diff)