aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--examples/charts/pointconfiguration/doc/pointconfiguration.rst2
-rw-r--r--examples/multimedia/audiosource/doc/audiosource.rst2
-rw-r--r--sources/pyside6/doc/CMakeLists.txt2
-rw-r--r--sources/pyside6/doc/_tags/android.rst2
-rw-r--r--sources/pyside6/doc/api.rst2
-rw-r--r--sources/pyside6/doc/building_from_source/index.rst6
-rw-r--r--sources/pyside6/doc/considerations.rst2
-rw-r--r--sources/pyside6/doc/deployment/deployment-pyside6-android-deploy.rst2
-rw-r--r--sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst4
-rw-r--r--sources/pyside6/doc/faq/porting_from2.rst2
-rw-r--r--sources/pyside6/doc/gettingstarted.rst2
-rw-r--r--sources/pyside6/doc/index.rst23
-rw-r--r--sources/pyside6/doc/tools/pyside6-balsam.rst2
-rw-r--r--sources/pyside6/doc/tools/pyside6-qsb.rst2
-rw-r--r--sources/pyside6/doc/tutorials/portingguide/index.rst12
15 files changed, 33 insertions, 34 deletions
diff --git a/examples/charts/pointconfiguration/doc/pointconfiguration.rst b/examples/charts/pointconfiguration/doc/pointconfiguration.rst
index ffe865d5e..479d7b4e1 100644
--- a/examples/charts/pointconfiguration/doc/pointconfiguration.rst
+++ b/examples/charts/pointconfiguration/doc/pointconfiguration.rst
@@ -141,4 +141,4 @@ and ``@index``. These are replaced with the x value, y value, and index of the p
More information about that can be found in the documentation for
`QtCharts.QXYSeries.pointLabelsFormat`_.
-.. _`QtCharts.QXYSeries.pointLabelsFormat`: https://doc.qt.io/qtforpython/PySide6/QtCharts/QXYSeries.html#PySide6.QtCharts.PySide6.QtCharts.QXYSeries.pointLabelsFormat
+.. _`QtCharts.QXYSeries.pointLabelsFormat`: https://doc.qt.io/qt-6/qxyseries.html#pointLabelsFormat-prop
diff --git a/examples/multimedia/audiosource/doc/audiosource.rst b/examples/multimedia/audiosource/doc/audiosource.rst
index 3a247c503..6504a9251 100644
--- a/examples/multimedia/audiosource/doc/audiosource.rst
+++ b/examples/multimedia/audiosource/doc/audiosource.rst
@@ -4,7 +4,7 @@ Audio Source Example
.. tags:: Android
A Python application that demonstrates the analogous example in C++
-`Audio Source Example <https://doc-snapshots.qt.io/qt6-dev/qtmultimedia-multimedia-audiosource-example.html>`_
+`Audio Source Example <https://doc.qt.io/qt-6/qtmultimedia-audiosource-example.html>`_
.. image:: audiosource.png
diff --git a/sources/pyside6/doc/CMakeLists.txt b/sources/pyside6/doc/CMakeLists.txt
index 83583756f..4cc4f2e8e 100644
--- a/sources/pyside6/doc/CMakeLists.txt
+++ b/sources/pyside6/doc/CMakeLists.txt
@@ -117,7 +117,7 @@ set(HAS_WEBENGINE_WIDGETS 0)
set(SKIP_SPHINX_WARNINGS 1)
if (FULLDOCSBUILD)
set(SKIP_SPHINX_WARNINGS 0)
- set(SHIBOKEN_INTERSPHINX_FILE "${CMAKE_BINARY_DIR}/doc/html/shiboken6/doc/html/objects.inv")
+ set(SHIBOKEN_INTERSPHINX_FILE "${CMAKE_BINARY_DIR}/doc/html/shiboken6/objects.inv")
# For Qt modules that are part of the documentation build:
# - Configure the module docconf file
# - Write shiboken header consisting of pyside6_global.h and module includes
diff --git a/sources/pyside6/doc/_tags/android.rst b/sources/pyside6/doc/_tags/android.rst
index 08a30fc0f..0fdf2041a 100644
--- a/sources/pyside6/doc/_tags/android.rst
+++ b/sources/pyside6/doc/_tags/android.rst
@@ -1,3 +1,5 @@
+.. _sphx_tag_android:
+
My tags: Android
################
diff --git a/sources/pyside6/doc/api.rst b/sources/pyside6/doc/api.rst
index 7bbe2ce1c..bd80ab222 100644
--- a/sources/pyside6/doc/api.rst
+++ b/sources/pyside6/doc/api.rst
@@ -29,7 +29,7 @@ These are the main modules that help you build a Widget-based UI.
QML and Qt Quick
----------------
-Use these modules to interact with the `QML Language <https://doc.qt.io/qt-5.qmlapplications>`_,
+Use these modules to interact with the `QML Language <https://doc.qt.io/qt-6/qmlapplications.html>`_,
from Python.
.. grid:: 1 3 3 3
diff --git a/sources/pyside6/doc/building_from_source/index.rst b/sources/pyside6/doc/building_from_source/index.rst
index 24f6cd128..70c876005 100644
--- a/sources/pyside6/doc/building_from_source/index.rst
+++ b/sources/pyside6/doc/building_from_source/index.rst
@@ -1,3 +1,5 @@
+.. _buildingfromsource:
+
Building from Source
====================
@@ -391,7 +393,7 @@ Troubleshooting
--shiboken-host-path=...
-.. _`Manjaro ARM`: https://manjaro.org/download/#ARM
+.. _`Manjaro ARM`: https://manjaro.org/products/download/arm
.. _`Archlinux ARM`: https://archlinuxarm.org
.. _`ARM Developer Cross Compilers`: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-a/downloads
.. _`gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu.tar.xz`: https://developer.arm.com/-/media/Files/downloads/gnu-a/10.2-2020.11/binrel/gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu.tar.xz
@@ -505,7 +507,7 @@ The offline documentation (QCH) can be viewed using the *Qt Creator* IDE or
*Qt Assistant*, which is a standalone application for viewing QCH files.
To view the QCH using *Qt Creator*, following the instructions outlined in
-`Using Qt Creator Help Mode <https://doc.qt.io/qtcreator/creator-help.html>`_.
+`Using Qt Creator Help Mode <https://doc.qt.io/qtcreator/creator-how-to-add-external-documentation.html>`_.
If you chose to use *Qt Assistant* instead, use the following command to register
the QCH file before launching *Qt Assistant*::
diff --git a/sources/pyside6/doc/considerations.rst b/sources/pyside6/doc/considerations.rst
index c6a07ff56..07be2b772 100644
--- a/sources/pyside6/doc/considerations.rst
+++ b/sources/pyside6/doc/considerations.rst
@@ -197,7 +197,7 @@ With the above features selected, this reads:
self.table.horizontal_header().section_resize_mode = QHeaderView.Stretch
Additionally, properties can also be declared directly in Shiboken for
-non Qt-libraries, see :ref:`property-declare`.
+non Qt-libraries, see :ref:`property-declare <shiboken6:property-declare>`.
More about features
~~~~~~~~~~~~~~~~~~~
diff --git a/sources/pyside6/doc/deployment/deployment-pyside6-android-deploy.rst b/sources/pyside6/doc/deployment/deployment-pyside6-android-deploy.rst
index 53944f6ea..a09c88af5 100644
--- a/sources/pyside6/doc/deployment/deployment-pyside6-android-deploy.rst
+++ b/sources/pyside6/doc/deployment/deployment-pyside6-android-deploy.rst
@@ -176,7 +176,7 @@ done only once per Qt version, irrespective of the number of applications you ar
Currently, cross-compiling Qt for Python wheels only works with a Linux host. Follow these steps
to cross-compile Qt for Python Android wheels.
-#. `Download <qt_download>`_ and install Qt version for which you would like to create Qt for Python
+#. `Download <qt_download_>`_ and install Qt version for which you would like to create Qt for Python
wheels.
#. Cloning the Qt for Python repository::
diff --git a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
index 9e8ef829f..62b2451cc 100644
--- a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
+++ b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
@@ -62,7 +62,7 @@ directory), to take the parameters from that file. This can be done with the fol
pysidedeploy.spec
=================
-As mentioned in the `Approach 2 <approach_two>`_ above, you can use this file to control the various
+As mentioned in the :ref:`Approach 2 <approach_two>` above, you can use this file to control the various
parameters of the deployment process. The file has multiple sections, with each section containing
multiple keys (parameters being controlled) assigned to a value. The advantages of such a file are
two folds:
@@ -227,7 +227,7 @@ Creating a bug report
If you are unsure if the bug is from ``pyside6-deploy`` or ``Nuitka``:
#. Create a bug report in Qt for Python. See instructions
- `here <https://wiki.qt.io/Qt_for_Python/Reporting_Bugs/>`_.
+ `here <https://wiki.qt.io/Qt_for_Python/Reporting_Bugs>`_.
#. Run ``pyside6-deploy`` command with the ``--verbose`` option and replace ``--quiet`` with
``--verbose`` in the ``extra_args`` parameter in the ``pysidedeploy.spec`` file. Attach the
diff --git a/sources/pyside6/doc/faq/porting_from2.rst b/sources/pyside6/doc/faq/porting_from2.rst
index 6699f54e0..33f1a4214 100644
--- a/sources/pyside6/doc/faq/porting_from2.rst
+++ b/sources/pyside6/doc/faq/porting_from2.rst
@@ -1,3 +1,5 @@
+.. _faq-porting-from2:
+
Porting Applications from PySide2 to PySide6
============================================
diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst
index 0a9422a83..0b5eee57a 100644
--- a/sources/pyside6/doc/gettingstarted.rst
+++ b/sources/pyside6/doc/gettingstarted.rst
@@ -22,7 +22,7 @@ Before you can install |project|, first you must install the following software:
`virtualenv <https://virtualenv.pypa.io/en/latest>`_
and avoid installing PySide6 via ``pip`` in your system.
-.. note:: For Windows users, please use the interpreter from https://python.org/download
+.. note:: For Windows users, please use the interpreter from https://www.python.org/downloads/
rather than the one installed from the Microsoft Store.
Installation
diff --git a/sources/pyside6/doc/index.rst b/sources/pyside6/doc/index.rst
index cca4aa9ce..8c614978a 100644
--- a/sources/pyside6/doc/index.rst
+++ b/sources/pyside6/doc/index.rst
@@ -7,7 +7,7 @@
which enables you to use Python to write your Qt applications.
The project has two main components:
- * `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
+ * :ref:`PySide6 <getting-started>`, so that you can use Qt6 APIs in your Python applications, and
* `Shiboken6 <shiboken6/index.html>`__, a binding generator tool, which can
be used to expose C++ projects to Python, and a Python module with
some utility functions.
@@ -18,35 +18,28 @@
which enables you to use Python to write your Qt applications.
The project has two main components:
- * `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
+ * :ref:`PySide6 <getting-started>`, so that you can use Qt6 APIs in your Python applications, and
* `Shiboken6 <../shiboken6/index.html>`__, a binding generator tool, which can
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.
+:ref:`Porting from PySide2 to PySide6 <faq-porting-from2>` 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: gettingstarted.html
-.. _`Qt commercial license`: https://www.qt.io/licensing/
-.. _`Porting from PySide2 to PySide6`: faq/porting_from2.html
+.. _`Qt commercial license`: https://www.qt.io/licensing/`
Quick Start
===========
You can obtain the latest stable version by running ``pip install pyside6``.
-If you want to build it yourself, check the `Building from Source`_ guide.
+If you want to build it yourself, check the :ref:`Building from Source <buildingfromsource>` guide.
-To learn how to use it, check out `write your first application`_,
+To learn how to use it, check out :ref:`write your first application <gettingstarted>`,
and to learn what is installed with the ``pyside6``, check the
-`package content, structure, and tools`_ page.
-
-
-.. _`Building from Source`: building_from_source/index.html
-.. _`write your first application`: gettingstarted.html
-.. _`package content, structure, and tools`: package_details.html
+:ref:`package content, structure, and tools <package_details>` page.
Documentation
=============
diff --git a/sources/pyside6/doc/tools/pyside6-balsam.rst b/sources/pyside6/doc/tools/pyside6-balsam.rst
index c6677f6a3..f3f88ac4f 100644
--- a/sources/pyside6/doc/tools/pyside6-balsam.rst
+++ b/sources/pyside6/doc/tools/pyside6-balsam.rst
@@ -3,7 +3,7 @@
pyside6-balsam
==============
-``pyside6-qsb`` is a tool that wraps the `balsam <Balsam Asset Import Tool>`_
+``pyside6-qsb`` is a tool that wraps the `balsam <Balsam Asset Import Tool_>`_
tool provided with Qt Quick 3D. The Balsam tool is a command line application
that is part of Qt Quick 3D's asset conditioning pipeline. The purpose is to
take assets created in digital content creation tools like `Maya`_, `3ds Max`_
diff --git a/sources/pyside6/doc/tools/pyside6-qsb.rst b/sources/pyside6/doc/tools/pyside6-qsb.rst
index f6f1847d4..c9d0c40f4 100644
--- a/sources/pyside6/doc/tools/pyside6-qsb.rst
+++ b/sources/pyside6/doc/tools/pyside6-qsb.rst
@@ -3,7 +3,7 @@
pyside6-qsb
===========
-``pyside6-qsb`` is a tool that wraps the `qsb <QSB Manual>`_ tool. qsb is a
+``pyside6-qsb`` is a tool that wraps the `qsb <QSB Manual_>`_ tool. qsb is a
command line tool provided by the `Qt Shader Tools`_ module. It integrates
third-party libraries such as `glslang`_ and `SPIRV-Cross`_, optionally invokes
external tools, such as ``fxc`` or ``spirv-opt``, and generates .qsb files.
diff --git a/sources/pyside6/doc/tutorials/portingguide/index.rst b/sources/pyside6/doc/tutorials/portingguide/index.rst
index 8f040a723..da8924183 100644
--- a/sources/pyside6/doc/tutorials/portingguide/index.rst
+++ b/sources/pyside6/doc/tutorials/portingguide/index.rst
@@ -66,23 +66,23 @@ In this example, ``func()`` would treat ``var`` as a local
name without the ``global`` statement. This would lead to
a ``NameError`` in the ``value is None`` handling, on
accessing ``var``. For more information about this, see
-`Python refernce documentation <python refdoc>`_.
+`Python reference documentation <python-refdoc_>`_.
-.. _python refdoc: https://docs.python.org/3/reference/simple_stmts.html#the-global-statement
+.. _python-refdoc: https://docs.python.org/3/reference/simple_stmts.html#the-global-statement
.. tip:: Python being an interpreted language, most often
- the easiest way is to try your idea in the interperter.
+ the easiest way is to try your idea in the interpreter.
You could call the ``help()`` function in the
interpreter on any built-in function or keyword in
Python. For example, a call to ``help(import)`` should
- provide documentation about the ``import`` statment
+ provide documentation about the ``import`` statement
Last but not the least, try out a few examples to
familiarize yourself with the Python coding style and
follow the guidelines outlined in the
-`PEP8 - Style Guide <pep8>`_.
+`PEP8 - Style Guide <pep8_>`_.
-.. _pep8: <https://www.python.org/dev/peps/pep-0008/#naming-conventions>
+.. _pep8: https://www.python.org/dev/peps/pep-0008/#naming-conventions
.. code-block:: python