diff options
| author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2023-03-14 15:24:13 +0100 |
|---|---|---|
| committer | Shyamnath Premnadh <shyamnath.premnadh@qt.io> | 2023-03-17 15:37:09 +0100 |
| commit | a922672c1c4f188cbab51b126b9cae4d7cd8706d (patch) | |
| tree | d16932f2fbed8c9b2dfac6b6136c654eec4b798c /sources/pyside6/doc/api.rst | |
| parent | 012e40e6af6355ff05feee899e60e041458ea741 (diff) | |
doc: migrate to sphinx-design and update sphinx
sphinx-panels is deprecated, and sphinx-design is the better
replacement.
This patch migrates everything we had in pyside and shiboken,
which was useful to remove many CSS related hacks for things
we were forcing before.
The example gallery was also adapted to generate sphinx-design
valid code. Additional adaptation to some examples and files were
included as well, which improved the overall example experience.
We used this to change to update sphinx as well, which before
was not possible to update due to sphinx-panels.
Fixes: PYSIDE-2244
Change-Id: Ia3f57f536591ea299bf87302e930203b64fafd7e
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Diffstat (limited to 'sources/pyside6/doc/api.rst')
| -rw-r--r-- | sources/pyside6/doc/api.rst | 60 |
1 files changed, 20 insertions, 40 deletions
diff --git a/sources/pyside6/doc/api.rst b/sources/pyside6/doc/api.rst index 62273c31f..7bbe2ce1c 100644 --- a/sources/pyside6/doc/api.rst +++ b/sources/pyside6/doc/api.rst @@ -8,33 +8,23 @@ Basic modules These are the main modules that help you build a Widget-based UI. -.. panels:: - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 +.. grid:: 1 3 3 3 + :gutter: 2 - :mod:`QtCore <PySide6.QtCore>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtCore <PySide6.QtCore>` - Provides core non-GUI functionality, like signal and - slots, properties, base classes of item models, - serialization, and more. + Provides core non-GUI functionality, like signal and slots, properties, + base classes of item models, serialization, and more. - --- + .. grid-item-card:: :mod:`QtGui <PySide6.QtGui>` - :mod:`QtGui <PySide6.QtGui>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Extends QtCore with GUI functionality: Events, windows and screens, + OpenGL and raster-based 2D painting, as well as images. - Extends QtCore with GUI functionality: Events, windows - and screens, OpenGL and raster-based 2D painting, as - well as images. + .. grid-item-card:: :mod:`QtWidgets <PySide6.QtWidgets>` - --- - - :mod:`QtWidgets <PySide6.QtWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Provides ready to use Widgets for your application, - including graphical elements for your UI. + Provides ready to use Widgets for your application, including graphical + elements for your UI. QML and Qt Quick ---------------- @@ -42,31 +32,21 @@ QML and Qt Quick Use these modules to interact with the `QML Language <https://doc.qt.io/qt-5.qmlapplications>`_, from Python. -.. panels:: - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 - - :mod:`QtQml <PySide6.QtQml>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - The base Python API to interact with the - module. +.. grid:: 1 3 3 3 + :gutter: 2 - --- + .. grid-item-card:: :mod:`QtQml <PySide6.QtQml>` - :mod:`QtQuick <PySide6.QtQuick>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + The base Python API to interact with the module. - Provides classes to embed Qt Quick in Qt - applications. + .. grid-item-card:: :mod:`QtQuick <PySide6.QtQuick>` - --- + Provides classes to embed Qt Quick in Qt applications. - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` - Provides the QQuickWidget class to embed Qt - Quick in widget-based applications. + Provides the QQuickWidget class to embed Qt Quick in widget-based + applications. All the modules --------------- |