Skip to content

Commit

Permalink
Complete module documentation for 6.7
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
FriedemannKleint committed Sep 26, 2024
1 parent f368b8a commit df57b24
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ explore2
build_history/2*

*.qdocconf
*.qdocconf.in

*.egg-info
*.pyc
Expand Down
23 changes: 23 additions & 0 deletions sources/pyside6/doc/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,24 @@ Qt Modules Supported by Qt for Python

Extends QtCore with GUI functionality.

.. grid-item-card:: :mod:`Qt Graphs <PySide6.QtGraphs>`

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 <PySide6.QtHelp>`

Provides classes for integrating online documentation in applications.

.. grid-item-card:: :mod:`Qt HTTP Server <PySide6.QtHttpServer>`

A framework for embedding an HTTP server into a Qt application.

.. grid-item-card:: :mod:`Qt Location <PySide6.QtLocation>`

Provides QML and Python interfaces to create location-aware applications.

.. grid-item-card:: :mod:`Qt Multimedia <PySide6.QtMultimedia>`

Provides API for multimedia-specific use cases.
Expand Down Expand Up @@ -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 <PySide6.QtQuick3D>`

Provides a high-level API for creating 3D content or UIs based on Qt Quick.

.. grid-item-card:: :mod:`QtQuickControls2 <PySide6.QtQuickControls2>`

Provides classes for setting up the controls from C++.
Expand Down Expand Up @@ -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 <PySide6.QtTextToSpeech>`

Provides support for synthesizing speech from text and playing it as audio
output.

.. grid-item-card:: :mod:`QtUiTools <PySide6.QtUiTools>`

Provides classes to handle forms created with *Qt Widgets Designer*.
Expand Down
2 changes: 2 additions & 0 deletions sources/pyside6/doc/qtmodules/pyside-qtgraphs.qdocconf.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include(@QT_SRC_DIR@/../qtgraphs/src/doc/qtgraphs.qdocconf)
include(../pyside-config.qdocconf)
2 changes: 2 additions & 0 deletions sources/pyside6/doc/qtmodules/pyside-qthttpserver.qdocconf.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include(@QT_SRC_DIR@/../qthttpserver/doc/config/qthttpserver.qdocconf)
include(../pyside-config.qdocconf)
2 changes: 2 additions & 0 deletions sources/pyside6/doc/qtmodules/pyside-qtlocation.qdocconf.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include(@QT_SRC_DIR@/../qtlocation/src/location/doc/qtlocation.qdocconf)
include(../pyside-config.qdocconf)
2 changes: 2 additions & 0 deletions sources/pyside6/doc/qtmodules/pyside-qtquick3d.qdocconf.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include(@QT_SRC_DIR@/../qtquick3d/src/quick3d/doc/qtquick3d.qdocconf)
include(../pyside-config.qdocconf)

0 comments on commit df57b24

Please sign in to comment.