From df57b24a7086bb776ba1aad90140ef808eddb74a Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Tue, 24 Sep 2024 13:14:16 +0200 Subject: [PATCH] Complete module documentation for 6.7 Add missing modules to the index page and add missing qdocconf files. Pick-to: 6.7 Task-number: PYSIDE-1112 Change-Id: Ide552aae911af86dea444733acf5fd3c00d8b899 Reviewed-by: Cristian Maureira-Fredes --- .gitignore | 1 - sources/pyside6/doc/modules.rst | 23 +++++++++++++++++++ .../doc/qtmodules/pyside-qtgraphs.qdocconf.in | 2 ++ .../qtmodules/pyside-qthttpserver.qdocconf.in | 2 ++ .../qtmodules/pyside-qtlocation.qdocconf.in | 2 ++ .../qtmodules/pyside-qtquick3d.qdocconf.in | 2 ++ 6 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 sources/pyside6/doc/qtmodules/pyside-qtgraphs.qdocconf.in create mode 100644 sources/pyside6/doc/qtmodules/pyside-qthttpserver.qdocconf.in create mode 100644 sources/pyside6/doc/qtmodules/pyside-qtlocation.qdocconf.in create mode 100644 sources/pyside6/doc/qtmodules/pyside-qtquick3d.qdocconf.in diff --git a/.gitignore b/.gitignore index 65cb058636..e898e69934 100644 --- a/.gitignore +++ b/.gitignore @@ -21,7 +21,6 @@ explore2 build_history/2* *.qdocconf -*.qdocconf.in *.egg-info *.pyc diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 3534272080..c02c98286d 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -50,10 +50,24 @@ Qt Modules Supported by Qt for Python Extends QtCore with GUI functionality. + .. grid-item-card:: :mod:`Qt Graphs ` + + Provides functionality for visualizing data in 3D as bar, scatter, and + surface graphs, as well as 2D in area, bar, donut, line, pie, scatter, and + spline graphs. + .. grid-item-card:: :mod:`QtHelp ` Provides classes for integrating online documentation in applications. + .. grid-item-card:: :mod:`Qt HTTP Server ` + + A framework for embedding an HTTP server into a Qt application. + + .. grid-item-card:: :mod:`Qt Location ` + + Provides QML and Python interfaces to create location-aware applications. + .. grid-item-card:: :mod:`Qt Multimedia ` Provides API for multimedia-specific use cases. @@ -110,6 +124,10 @@ Qt Modules Supported by Qt for Python Provides classes for embedding Qt Quick in Qt applications. + .. grid-item-card:: :mod:`Qt Quick 3D ` + + Provides a high-level API for creating 3D content or UIs based on Qt Quick. + .. grid-item-card:: :mod:`QtQuickControls2 ` Provides classes for setting up the controls from C++. @@ -171,6 +189,11 @@ Qt Modules Supported by Qt for Python Provides classes for unit testing Qt applications and libraries. + .. grid-item-card:: :mod:`QtTextToSpeech ` + + Provides support for synthesizing speech from text and playing it as audio + output. + .. grid-item-card:: :mod:`QtUiTools ` Provides classes to handle forms created with *Qt Widgets Designer*. diff --git a/sources/pyside6/doc/qtmodules/pyside-qtgraphs.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtgraphs.qdocconf.in new file mode 100644 index 0000000000..7f83171636 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtgraphs.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtgraphs/src/doc/qtgraphs.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qthttpserver.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qthttpserver.qdocconf.in new file mode 100644 index 0000000000..09f3f04d7c --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qthttpserver.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qthttpserver/doc/config/qthttpserver.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtlocation.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtlocation.qdocconf.in new file mode 100644 index 0000000000..388289ec4e --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtlocation.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtlocation/src/location/doc/qtlocation.qdocconf) +include(../pyside-config.qdocconf) diff --git a/sources/pyside6/doc/qtmodules/pyside-qtquick3d.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtquick3d.qdocconf.in new file mode 100644 index 0000000000..64f0cce0e6 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtquick3d.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtquick3d/src/quick3d/doc/qtquick3d.qdocconf) +include(../pyside-config.qdocconf)