diff options
author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2021-10-20 13:32:20 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-10-20 23:27:43 +0000 |
commit | ba4811534b1604af4b77af7b2438256779003654 (patch) | |
tree | d5759bc00242465874c9390155767449c79cac12 | |
parent | bbe91cf3b0f2cef64ae71f71669e6462988e6c00 (diff) |
doc: include missing modules
The following modules were not generated automatically
in the documentation:
- QtBluetooth
- QtDBus
- QtNetworkAuth
- QtRemoteObjects
- QtSerialPort
The two column order of the modules.rst page was removed
in favor of moving the page to a box-style in the future.
Fixes: PYSIDE-1694
Change-Id: Ied62d15c0f4574d0e4f5a8202e5f08692f63e001
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
(cherry picked from commit 136c777f0c39b197f9f893f17006173f7be1d5de)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
6 files changed, 98 insertions, 72 deletions
diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 31937f291..013401905 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -11,75 +11,91 @@ Qt Modules :widths: 150, 150 :align: left - * - :mod:`Qt Charts <PySide6.QtCharts>` - Provides a set of easy to use chart components. - - :mod:`QtConcurrent <PySide6.QtConcurrent>` - Provides high-level APIs that make it possible - to write multi-threaded programs without using low-level threading - primitives such as mutexes, read-write locks, wait conditions, or semaphores. - * - :mod:`QtCore <PySide6.QtCore>` - Provides core non-GUI functionality. - - :mod:`Qt DataVisualization <PySide6.QtDataVisualization>` - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - * - :mod:`QtDesigner <PySide6.QtDesigner>` - Provides classes to extend Qt Designer. - - :mod:`QtGui <PySide6.QtGui>` - Extends QtCore with GUI functionality. - * - :mod:`QtHelp <PySide6.QtHelp>` - Provides classes for integrating online documentation in applications. - - :mod:`QtNetwork <PySide6.QtNetwork>` - Offers classes that let you to write TCP/IP clients and servers. - * - :mod:`QtOpenGL <PySide6.QtOpenGL>` - Offers classes that make it easy to use OpenGL in Qt applications. - - :mod:`QtOpenGLFunctions <PySide6.QtOpenGLFunctions>` - The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. - * - :mod:`QtOpenGLWidgets <PySide6.QtOpenGLWidgets>` - The QOpenGLWidget class is a widget for rendering OpenGL graphics. - - :mod:`QtPrintSupport <PySide6.QtPrintSupport>` - Provides extensive cross-platform support for printing. - * - :mod:`QtQml <PySide6.QtQml>` - Python API for Qt QML. - - :mod:`QtQuick <PySide6.QtQuick>` - Provides classes for embedding Qt Quick in Qt applications. - * - :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` - Provides classes for setting up the controls from C++. - - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - * - :mod:`Qt Scxml <PySide6.QtScxml>` - Provides classes to create and use state machines from SCXML files. - - :mod:`QtSql <PySide6.QtSql>` - Helps you provide seamless database integration to your Qt applications. - * - :mod:`QtStateMachine <PySide6.QtStateMachine>` - Provides classes for creating and executing state graphs. - - :mod:`QtSvg <PySide6.QtSvg>` - Provides classes for displaying the contents of SVG files. - * - :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` - Provides a widget that is used to display the contents of SVG files. - - :mod:`QtTest <PySide6.QtTest>` - Provides classes for unit testing Qt applications and libraries. - * - :mod:`QtUiTools <PySide6.QtUiTools>` - Provides classes to handle forms created with Qt Designer. - - :mod:`QtWidgets <PySide6.QtWidgets>` - Extends Qt GUI with C++ widget functionality. - * - :mod:`QtXml <PySide6.QtXml>` - Provides a C++ implementation of DOM. - - :mod:`Qt 3D Animation <PySide6.Qt3DAnimation>` - Provides basic elements required to animate 3D objects. - * - :mod:`Qt WebEngine Core C++ Classes <PySide6.QtWebEngineCore>` - Provides public API shared by both QtWebEngine and QtWebEngineWidgets. - - :mod:`Qt WebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` - Provides C++ classes for rendering web content in a QWidget based application. - * - :mod:`Qt WebEngine QML Types <PySide6.QtWebEngineQuick>` - Provides QML types for rendering web content within a QML application. - - - * - :mod:`Qt 3D Core <PySide6.Qt3DCore>` - Contains functionality to support near-realtime simulation systems. - - :mod:`Qt 3D Extras <PySide6.Qt3DExtras>` - Provides a set of prebuilt elements to help you get started with Qt 3D. - * - :mod:`Qt 3D Input <PySide6.Qt3DInput>` - Provides classes for handling user input in applications using Qt 3D. - - :mod:`Qt 3D Logic <PySide6.Qt3DLogic>` - Enables synchronizing frames with the Qt 3D backend. - * - :mod:`Qt 3D Render <PySide6.Qt3DRender>` - Contains functionality to support 2D and 3D rendering using Qt 3D. - - + - :mod:`QtBluetooth <PySide6.QtBluetooth>` + The Bluetooth API provides connectivity between Bluetooth enabled devices. + - :mod:`QtCharts <PySide6.QtCharts>` + Provides a set of easy to use chart components. + - :mod:`QtConcurrent <PySide6.QtConcurrent>` + Provides high-level APIs that make it possible + to write multi-threaded programs without using low-level threading + primitives such as mutexes, read-write locks, wait conditions, or semaphores. + - :mod:`QtCore <PySide6.QtCore>` + Provides core non-GUI functionality. + - :mod:`QtDataVisualization <PySide6.QtDataVisualization>` + Provides a way to visualize data in 3D as bar, scatter, and surface graphs. + - :mod:`QtDBus <PySide6.QtDBus>` + D-Bus is an Inter-Process Communication (IPC) and Remote Procedure + Calling (RPC) mechanism originally developed for Linux to replace + existing and competing IPC solutions with one unified protocol + - :mod:`QtDesigner <PySide6.QtDesigner>` + Provides classes to extend Qt Designer. + - :mod:`QtGui <PySide6.QtGui>` + Extends QtCore with GUI functionality. + - :mod:`QtHelp <PySide6.QtHelp>` + Provides classes for integrating online documentation in applications. + - :mod:`QtNetwork <PySide6.QtNetwork>` + Offers classes that let you to write TCP/IP clients and servers. + - :mod:`QtNetworkAuth <PySide6.QtNetworkAuth>` + Provides a set of APIs that enable Qt applications to obtain limited + access to online accounts and HTTP services without exposing users' + passwords. + - :mod:`QtRemoteObjects <PySide6.QtRemoteObjects>` + Inter-Process Communication (IPC) module developed for Qt. This module + extends Qt's existing functionalities to enable information exchange + between processes or computers, easily. + - :mod:`QtOpenGL <PySide6.QtOpenGL>` + Offers classes that make it easy to use OpenGL in Qt applications. + - :mod:`QtOpenGLFunctions <PySide6.QtOpenGLFunctions>` + The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. + - :mod:`QtOpenGLWidgets <PySide6.QtOpenGLWidgets>` + The QOpenGLWidget class is a widget for rendering OpenGL graphics. + - :mod:`QtPrintSupport <PySide6.QtPrintSupport>` + Provides extensive cross-platform support for printing. + - :mod:`QtQml <PySide6.QtQml>` + Python API for Qt QML. + - :mod:`QtQuick <PySide6.QtQuick>` + Provides classes for embedding Qt Quick in Qt applications. + - :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` + Provides classes for setting up the controls from C++. + - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` + Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. + - :mod:`Qt Scxml <PySide6.QtScxml>` + Provides classes to create and use state machines from SCXML files. + - :mod:`QtSql <PySide6.QtSql>` + Helps you provide seamless database integration to your Qt applications. + - :mod:`QtStateMachine <PySide6.QtStateMachine>` + Provides classes for creating and executing state graphs. + - :mod:`QtSerialPort <PySide6.QtSerialPort>` + Provides the basic functionality, which includes configuring, I/O + operations, getting and setting the control signals of the RS-232 + pinouts. + - :mod:`QtSvg <PySide6.QtSvg>` + Provides classes for displaying the contents of SVG files. + - :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` + Provides a widget that is used to display the contents of SVG files. + - :mod:`QtTest <PySide6.QtTest>` + Provides classes for unit testing Qt applications and libraries. + - :mod:`QtUiTools <PySide6.QtUiTools>` + Provides classes to handle forms created with Qt Designer. + - :mod:`QtWidgets <PySide6.QtWidgets>` + Extends Qt GUI with C++ widget functionality. + - :mod:`QtXml <PySide6.QtXml>` + Provides a C++ implementation of DOM. + - :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>` + Provides basic elements required to animate 3D objects. + - :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>` + Provides public API shared by both QtWebEngine and QtWebEngineWidgets. + - :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` + Provides C++ classes for rendering web content in a QWidget based application. + - :mod:`QtWebEngine QML Types <PySide6.QtWebEngineQuick>` + Provides QML types for rendering web content within a QML application. + - :mod:`Qt3D Core <PySide6.Qt3DCore>` + Contains functionality to support near-realtime simulation systems. + - :mod:`Qt3D Extras <PySide6.Qt3DExtras>` + Provides a set of prebuilt elements to help you get started with Qt 3D. + - :mod:`Qt3D Input <PySide6.Qt3DInput>` + Provides classes for handling user input in applications using Qt 3D. + - :mod:`Qt3D Logic <PySide6.Qt3DLogic>` + Enables synchronizing frames with the Qt 3D backend. + - :mod:`Qt3D Render <PySide6.Qt3DRender>` + Contains functionality to support 2D and 3D rendering using Qt 3D. diff --git a/sources/pyside6/doc/qtmodules/pyside-qtbluetooth.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtbluetooth.qdocconf.in new file mode 100644 index 000000000..0867ff0c2 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtbluetooth.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtconnectivity/src/bluetooth/doc/qtbluetooth.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtdbus.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtdbus.qdocconf.in new file mode 100644 index 000000000..d291d92bd --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtdbus.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/src/dbus/doc/qtdbus.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtnetworkauth.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtnetworkauth.qdocconf.in new file mode 100644 index 000000000..45a20bdd9 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtnetworkauth.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtnetworkauth/src/oauth/doc/qtnetworkauth.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtremoteobjects.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtremoteobjects.qdocconf.in new file mode 100644 index 000000000..dfad130e6 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtremoteobjects.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtremoteobjects/src/remoteobjects/doc/qtremoteobjects.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtserialport.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtserialport.qdocconf.in new file mode 100644 index 000000000..da1b75f7d --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtserialport.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtserialport/src/serialport/doc/qtserialport.qdocconf) +include(../pyside-config.qdocconf) |