doc: fix issues with pyside rst files

Fixing extra indentation, syntax issues, and formatting. Adapting too some snippet line highlights, and many other details. Pick-to: 6.5 Change-Id: Ife4eb5cec03577b2902d409b4007ae6d12141747 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
author: Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> 2023-04-04 17:19:23 +0200
committer: Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> 2023-04-05 09:26:43 +0200
commit: 900c050c66119454585ec83cf31149f6d64dd3ea (patch)
tree: c9db45471d33aaf9ca6ad7de191d73eed2cbec24 /sources/pyside6/doc/gettingstarted
parent: d35b650fe4369952a44c3891fedb6d8ee1417df5 (diff)
5 files changed, 42 insertions, 42 deletions
diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst
index 9de7587c4..f24f9dd4f 100644
--- a/sources/pyside6/doc/gettingstarted/index.rst
+++ b/sources/pyside6/doc/gettingstarted/index.rst
@@ -17,12 +17,12 @@ On **Linux** you might get them with your operating system package manager, on *
 you might get them with ``brew``, and on **Windows** you can download the installer from each
 website.
 
- * **Python**: 3.7+ `[official Python website] <https://www.python.org/downloads/>`_
- * **Qt:** 6.4+ `[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+.
-   Prebuilt versions for each OS can be `downloaded here`_.
+* **Python**: 3.7+ `[official Python website] <https://www.python.org/downloads/>`_
+* **Qt:** 6.4+ `[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+.
+  Prebuilt versions for each OS can be `downloaded here`_.
 
 .. _downloaded here: https://download.qt.io/development_releases/prebuilt/libclang/
 
diff --git a/sources/pyside6/doc/gettingstarted/linux.rst b/sources/pyside6/doc/gettingstarted/linux.rst
index f5ef71bae..f3ea5f7b0 100644
--- a/sources/pyside6/doc/gettingstarted/linux.rst
+++ b/sources/pyside6/doc/gettingstarted/linux.rst
@@ -4,11 +4,11 @@ Getting Started on Linux
 Requirements
 ------------
 
- * GCC
- * ``sphinx`` package for the documentation (optional).
- * Depending on your linux distribution, the following dependencies might also be required:
+* GCC
+* ``sphinx`` package for the documentation (optional).
+* Depending on your linux distribution, the following dependencies might also be required:
 
-    * ``libgl-dev``, ``python-dev``, ``python-distutils``, and ``python-setuptools``.
+  * ``libgl-dev``, ``python-dev``, ``python-distutils``, and ``python-setuptools``.
 
 Building from source
 --------------------
@@ -59,7 +59,7 @@ Install the general dependencies::
 Building and Installing (setuptools)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The `setuptools` approach uses the `setup.py` file to execute the build,
+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.
@@ -76,7 +76,7 @@ To install on the current directory, just run::
 Building and Installing (cmake)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The `setuptools` approach includes internal `CMake` calls when
+The ``setuptools`` approach includes internal ``CMake`` calls when
 building and installing the project, but a CMake-only approach is only
 recommended for packaging the project for distribution builds.
 
diff --git a/sources/pyside6/doc/gettingstarted/macOS.rst b/sources/pyside6/doc/gettingstarted/macOS.rst
index 9d57c7ceb..ea173b9ed 100644
--- a/sources/pyside6/doc/gettingstarted/macOS.rst
+++ b/sources/pyside6/doc/gettingstarted/macOS.rst
@@ -4,11 +4,11 @@ Getting Started on macOS
 Requirements
 ------------
 
- * `XCode`_ 8.2 (macOS 10.11), 8.3.3 (macOS 10.12), 9 (macOS 10.13), 10.1 (macOS 10.14)
- * ``sphinx`` package for the documentation (optional).
- * Depending on your OS, the following dependencies might also be required:
+* `XCode`_ 8.2 (macOS 10.11), 8.3.3 (macOS 10.12), 9 (macOS 10.13), 10.1 (macOS 10.14)
+* ``sphinx`` package for the documentation (optional).
+* Depending on your OS, the following dependencies might also be required:
 
-   * ``libgl-dev``, ``python-dev``, ``python-distutils``, and ``python-setuptools``.
+  * ``libgl-dev``, ``python-dev``, ``python-distutils``, and ``python-setuptools``.
 
 .. _XCode: https://developer.apple.com/xcode/
 
diff --git a/sources/pyside6/doc/gettingstarted/porting_from2.rst b/sources/pyside6/doc/gettingstarted/porting_from2.rst
index 2d5c8414f..07f5b48c6 100644
--- a/sources/pyside6/doc/gettingstarted/porting_from2.rst
+++ b/sources/pyside6/doc/gettingstarted/porting_from2.rst
@@ -66,28 +66,28 @@ Class/Function Deprecations
 Then, the code base needs to be checked for usage of deprecated API and adapted
 accordingly. For example:
 
- * The High DPI scaling attributes ``Qt.AA_EnableHighDpiScaling``,
-   ``Qt.AA_DisableHighDpiScaling`` and ``Qt.AA_UseHighDpiPixmaps`` are
-   deprecated. High DPI is by default enabled in Qt 6 and cannot be turned off.
- * ``QDesktopWidget`` has been removed. ``QScreen`` should be used instead,
-   which can be retrieved using ``QWidget.screen()``,
-   ``QGuiApplication.primaryScreen()`` or ``QGuiApplication.screens()``.
- * ``QFontMetrics.width()`` has been renamed to ``horizontalAdvance()``.
- * ``QMouseEvent.pos()`` and ``QMouseEvent.globalPos()`` returning a ``QPoint``
-   as well as ``QMouseEvent.x()`` and ``QMouseEvent.y()`` returning ``int``
-   are now deprecated. ``QMouseEvent.position()`` and
-   ``QMouseEvent.globalPosition()`` returning a ``QPointF`` should be used
-   instead.
- * ``Qt.MidButton`` has been renamed to ``Qt.MiddleButton``.
- * ``QOpenGLVersionFunctionsFactory.get()`` instead of
-   ``QOpenGLContext.versionFunctions()`` should be used to obtain
-   *Open GL* functions.
- * ``QRegExp`` has been replaced by ``QRegularExpression``.
- * ``QWidget.mapToGlobal()`` and ``QWidget.mapFromGlobal()`` now also accept
-   and return ``QPointF``.
- * Functions named ``exec_`` (classes ``QCoreApplication``, ``QDialog``,
-   ``QEventLoop``) have been renamed to ``exec`` which became possible
-   in Python 3.
+* The High DPI scaling attributes ``Qt.AA_EnableHighDpiScaling``,
+  ``Qt.AA_DisableHighDpiScaling`` and ``Qt.AA_UseHighDpiPixmaps`` are
+  deprecated. High DPI is by default enabled in Qt 6 and cannot be turned off.
+* ``QDesktopWidget`` has been removed. ``QScreen`` should be used instead,
+  which can be retrieved using ``QWidget.screen()``,
+  ``QGuiApplication.primaryScreen()`` or ``QGuiApplication.screens()``.
+* ``QFontMetrics.width()`` has been renamed to ``horizontalAdvance()``.
+* ``QMouseEvent.pos()`` and ``QMouseEvent.globalPos()`` returning a ``QPoint``
+  as well as ``QMouseEvent.x()`` and ``QMouseEvent.y()`` returning ``int``
+  are now deprecated. ``QMouseEvent.position()`` and
+  ``QMouseEvent.globalPosition()`` returning a ``QPointF`` should be used
+  instead.
+* ``Qt.MidButton`` has been renamed to ``Qt.MiddleButton``.
+* ``QOpenGLVersionFunctionsFactory.get()`` instead of
+  ``QOpenGLContext.versionFunctions()`` should be used to obtain
+  *Open GL* functions.
+* ``QRegExp`` has been replaced by ``QRegularExpression``.
+* ``QWidget.mapToGlobal()`` and ``QWidget.mapFromGlobal()`` now also accept
+  and return ``QPointF``.
+* Functions named ``exec_`` (classes ``QCoreApplication``, ``QDialog``,
+  ``QEventLoop``) have been renamed to ``exec`` which became possible
+  in Python 3.
 
 More information can be found in the
 `Porting to Qt 6 <https://doc.qt.io/qt-6/portingguide.html>`_ Guide
diff --git a/sources/pyside6/doc/gettingstarted/windows.rst b/sources/pyside6/doc/gettingstarted/windows.rst
index dd266c8f4..f94421d24 100644
--- a/sources/pyside6/doc/gettingstarted/windows.rst
+++ b/sources/pyside6/doc/gettingstarted/windows.rst
@@ -7,9 +7,9 @@ selected when using the online installer.
 Requirements
 ------------
 
- * `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).
+* `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.
@@ -83,7 +83,7 @@ Creating Debug Builds
 * Choose *Custom Installation* when installing Python and tick the options for
   debug binaries and libraries
 
-* Use ``venv`` to create a virtual environment and pass the debug binary:
+* Use ``venv`` to create a virtual environment and pass the debug binary::
 
    python_d.exe -m venv testenv_d
author	Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>	2023-04-04 17:19:23 +0200
committer	Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>	2023-04-05 09:26:43 +0200
commit	900c050c66119454585ec83cf31149f6d64dd3ea (patch)
tree	c9db45471d33aaf9ca6ad7de191d73eed2cbec24 /sources/pyside6/doc/gettingstarted
parent	d35b650fe4369952a44c3891fedb6d8ee1417df5 (diff)