aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-09-29 07:35:34 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-09-29 07:35:34 +0200
commit3bbcb7b0e6e0342569aa155d695bca46a7459eb0 (patch)
treee3675d77f409db4ecbc4f92cdfdbfa62763cb2d4 /sources/pyside2/doc
parent9881b68c4c7bc1715cd266c41c63a3a918d83b07 (diff)
parent50247e7d4a67e892a85dff7472f889bac97c91c7 (diff)
Merge remote-tracking branch 'origin/5.15' into dev
Diffstat (limited to 'sources/pyside2/doc')
-rw-r--r--sources/pyside2/doc/deployment-briefcase.rst4
-rw-r--r--sources/pyside2/doc/deployment.rst2
-rw-r--r--sources/pyside2/doc/faq.rst4
-rw-r--r--sources/pyside2/doc/gettingstarted.rst3
-rw-r--r--sources/pyside2/doc/index.rst4
-rw-r--r--sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst2
-rw-r--r--sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst14
7 files changed, 19 insertions, 14 deletions
diff --git a/sources/pyside2/doc/deployment-briefcase.rst b/sources/pyside2/doc/deployment-briefcase.rst
index fec5e0d56..a5179a279 100644
--- a/sources/pyside2/doc/deployment-briefcase.rst
+++ b/sources/pyside2/doc/deployment-briefcase.rst
@@ -160,7 +160,7 @@ It creates a subdirectory each for the different platforms.
This step takes longer as it adds the packages listed in `requires` sections in the `pyproject.toml` file.
Build the application
----------------
+---------------------
::
briefcase build
@@ -175,7 +175,7 @@ You'll get::
Run the application
------------
+-------------------
::
briefcase run
diff --git a/sources/pyside2/doc/deployment.rst b/sources/pyside2/doc/deployment.rst
index 414a468ed..3d6aa218e 100644
--- a/sources/pyside2/doc/deployment.rst
+++ b/sources/pyside2/doc/deployment.rst
@@ -101,7 +101,7 @@ these tools don't offer a mechanism to update your application packages.
To create update packages, use the `PyUpdater <https://www.pyupdater.org/>`_, which is a tool
built around PyInstaller.
-The `fbs <https://build-system.fman.io>`_ tool offers a nice UI for the user to install the
+The `fbs`_ tool offers a nice UI for the user to install the
application step-by-step.
.. note::
diff --git a/sources/pyside2/doc/faq.rst b/sources/pyside2/doc/faq.rst
index f1aa3ebcc..b7e9816c8 100644
--- a/sources/pyside2/doc/faq.rst
+++ b/sources/pyside2/doc/faq.rst
@@ -1,3 +1,7 @@
+.. _faq:
+
+:orphan:
+
Frequently Asked Questions
==========================
diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst
index b8d6f9e45..197657493 100644
--- a/sources/pyside2/doc/gettingstarted.rst
+++ b/sources/pyside2/doc/gettingstarted.rst
@@ -7,10 +7,9 @@ with ``pip`` you need to run::
pip install pyside2
for more details, refer to our `Quick Start`_ guide. Additionally, you can
-check the `FAQ`_ related to the project.
+check the :ref:`FAQ <faq>` related to the project.
.. _Quick Start: quickstart.html
-.. _FAQ: faq.html
General Requirements
--------------------
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
index 289a653f3..ed5aeb6b4 100644
--- a/sources/pyside2/doc/index.rst
+++ b/sources/pyside2/doc/index.rst
@@ -5,13 +5,13 @@
**Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_),
so that you can use Qt5 APIs in your Python applications, and a binding generator tool
- (`Shiboken2 <shiboken2/index.html>`_) which can be used to expose C++ projects into Python.
+ (`Shiboken2 <shiboken2/index.html>`__) which can be used to expose C++ projects into Python.
.. ifconfig:: output_format == 'qthelp'
**Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_),
so that you can use Qt5 APIs in your Python applications, and a binding generator tool
- (`Shiboken2 <../shiboken2/index.html>`_) which can be used to expose C++ projects into Python.
+ (`Shiboken2 <../shiboken2/index.html>`__) which can be used to expose C++ projects into Python.
|project| is available under the LGPLv3/GPLv3 and the Qt commercial license.
diff --git a/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst b/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst
index 71b254811..6d7db9ef5 100644
--- a/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst
+++ b/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst
@@ -34,7 +34,7 @@ C++ version
.. literalinclude:: bookwindow.cpp
:language: c++
:linenos:
- :lines: 47-115
+ :lines: 57-140
Python version
---------------
diff --git a/sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst b/sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst
index c26d154ac..f675f7899 100644
--- a/sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst
+++ b/sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst
@@ -99,9 +99,10 @@ There are three properties that are almost always set when using ApplicationWind
Once we've set these, we have a properly sized, empty window ready to be filled with content.
There are two ways of laying out items in QML: `Item Positioners`_ and `Qt Quick Layouts`_.
-* Item positioners (`Row`_, `Column`_, and so on) are useful for situations where the size of items
+
+- Item positioners (`Row`_, `Column`_, and so on) are useful for situations where the size of items
is known or fixed, and all that is required is to neatly position them in a certain formation.
-* The layouts in Qt Quick Layouts can both position and resize items, making them well suited for
+- The layouts in Qt Quick Layouts can both position and resize items, making them well suited for
resizable user interfaces.
Below, we use `ColumnLayout`_ to vertically lay out a `ListView`_ and a `Pane`_.
@@ -205,14 +206,15 @@ if it doesn't already exist.
A few interesting things happen in the ``main`` function:
-* Declaring a :ref:`QGuiApplication`.
+
+- Declaring a :ref:`QGuiApplication`.
You should use a :ref:`QGuiApplication` instead of :ref:`QApplication` because we're not
using the **QtWidgets** module.
-* Connecting to the database,
-* Declaring a :ref:`QQmlApplicationEngine`.
+- Connecting to the database,
+- Declaring a :ref:`QQmlApplicationEngine`.
This allows you to access the QML context property to connect Python
and QML from the conversation model we built on ``sqlDialog.py``.
-* Loading the ``.qml`` file that defines the UI.
+- Loading the ``.qml`` file that defines the UI.
Finally, the Qt application runs, and your program starts.