From 5a7429cc895824a4eafd27e1a5c95b40bba86bdf Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 28 Sep 2020 08:12:38 +0200 Subject: Fix some sphinx warnings in Pyside2 documentation sources/pyside2/doc/deployment-briefcase.rst:163: WARNING: Title underline too short. sources/pyside2/doc/deployment-briefcase.rst:178: WARNING: Title underline too short. sources/pyside2/doc/deployment-briefcase.rst:178: WARNING: Title underline too short. sources/pyside2/doc/modules.rst:4: WARNING: toctree glob pattern 'PySide2/Qt*/index' didn't match any documents sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:103: WARNING: Unexpected indentation. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:104: WARNING: Block quote ends without a blank line; unexpected unindent. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:209: WARNING: Unexpected indentation. sources/pyside2/doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst:211: WARNING: Block quote ends without a blank line; unexpected unindent. Change-Id: I06900906584644ed585a386803ff33939fd11103 Reviewed-by: Cristian Maureira-Fredes --- sources/pyside2/doc/deployment-briefcase.rst | 4 ++-- .../doc/tutorials/qmlsqlintegration/qmlsqlintegration.rst | 14 ++++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) (limited to 'sources/pyside2/doc') 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/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. -- cgit v1.2.3