Documentation: Add groups

There are some special WebXML pages indicated by a <group> element that contain lists of classes with brief suitable for a "class list by function" section. Generate them to a separate directory for clarity and add them to the module pages. Task-number: PYSIDE-1106 Pick-to: 6.8 Change-Id: I4e2d0ef8c626502230078415a24547cd80c95bd9 Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
author: Friedemann Kleint <Friedemann.Kleint@qt.io> 2024-12-09 18:18:20 +0100
committer: Friedemann Kleint <Friedemann.Kleint@qt.io> 2024-12-10 09:41:31 +0100
commit: d822325096a4404d4215507a673e91166ec124b6 (patch)
tree: 0d88aa90df7e6a5c818f18b7832b071c5af26072 /sources/pyside6
parent: b60a27dcd43fa991ffd6a92182a0f2186d1a11ec (diff)
7 files changed, 52 insertions, 14 deletions
diff --git a/sources/pyside6/doc/additionaldocs.lst b/sources/pyside6/doc/additionaldocs.lst
index 82798b8e1..ebb620f34 100644
--- a/sources/pyside6/doc/additionaldocs.lst
+++ b/sources/pyside6/doc/additionaldocs.lst
@@ -1,7 +1,6 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
-# see README.md
 # A line enclosed in [] denotes a (relative) target directory
 
 [overviews]
@@ -24,16 +23,14 @@ qtconcurrent/webxml/qtconcurrentmap.webxml
 qtconcurrent/webxml/qtconcurrentrun.webxml
 qtconcurrent/webxml/qtconcurrenttask.webxml
 qtcore/webxml/animation-overview.webxml
-qtcore/webxml/animation.webxml
 qtcore/webxml/bindableproperties.webxml
+qtcore/webxml/cbor.webxml
 qtcore/webxml/containers.webxml
 qtcore/webxml/custom-types.webxml
 qtcore/webxml/datastreamformat.webxml
 qtcore/webxml/eventsandfilters.webxml
-qtcore/webxml/events.webxml
 qtcore/webxml/implicit-sharing.webxml
 qtcore/webxml/io-functions.webxml
-qtcore/webxml/io.webxml
 qtcore/webxml/ipc.webxml
 qtcore/webxml/java-style-iterators.webxml
 qtcore/webxml/json.webxml
@@ -127,8 +124,6 @@ qtdoc/webxml/wayland-and-qt.webxml
 qtgui/webxml/coordsys.webxml
 qtgui/webxml/dnd.webxml
 qtgui/webxml/gui-changes-qt6.webxml
-qtgui/webxml/painting-3d.webxml
-qtgui/webxml/painting.webxml
 qtgui/webxml/paintsystem-devices.webxml
 qtgui/webxml/paintsystem-drawing.webxml
 qtgui/webxml/paintsystem-images.webxml
@@ -145,7 +140,6 @@ qtgui/webxml/richtext-common-tasks.webxml
 qtgui/webxml/richtext-cursor.webxml
 qtgui/webxml/richtext-html-subset.webxml
 qtgui/webxml/richtext-layouts.webxml
-qtgui/webxml/richtext-processing.webxml
 qtgui/webxml/richtext-structure.webxml
 qtgui/webxml/richtext.webxml
 qthelp/webxml/helpsystem.webxml
@@ -160,7 +154,6 @@ qtmultimedia/webxml/qtmultimedia-apple.webxml
 qtmultimedia/webxml/qtmultimedia-changes-qt6.webxml
 qtmultimedia/webxml/videooverview.webxml
 qtnetwork/webxml/network-changes-qt6.webxml
-qtnetwork/webxml/network.webxml
 qtnetwork/webxml/qdtlsclientverifier-generatorparameters.webxml
 qtnetwork/webxml/qtnetwork-programming.webxml
 qtnetwork/webxml/ssl.webxml
@@ -177,7 +170,6 @@ qtpositioning/webxml/qtpositioning-android.webxml
 qtpositioning/webxml/qtpositioning-changes-qt6.webxml
 qtpositioning/webxml/qtpositioning-ios.webxml
 qtpositioning/webxml/qtpositioning-plugins.webxml
-qtprintsupport/webxml/printing.webxml
 qtprintsupport/webxml/printsupport-changes-qt6.webxml
 qtqml/webxml/qml-changes-qt6.webxml
 qtqml/webxml/qmldiskcache.webxml
@@ -267,8 +259,6 @@ qtquick/webxml/qtquick-positioning-anchors.webxml
 qtquick/webxml/qtquick-positioning-layouts.webxml
 qtquick/webxml/qtquick-positioning-righttoleft.webxml
 qtquick/webxml/qtquick-positioning-topic.webxml
-qtquick/webxml/qtquick-scenegraph-materials.webxml
-qtquick/webxml/qtquick-scenegraph-nodes.webxml
 qtquick/webxml/qtquick-statesanimations-animations.webxml
 qtquick/webxml/qtquick-statesanimations-behaviors.webxml
 qtquick/webxml/qtquick-statesanimations-states.webxml
@@ -317,7 +307,6 @@ qtsensors/webxml/qtsensors-cpp.webxml
 qtsensors/webxml/senorfwbackend.webxml
 qtsensors/webxml/sensors-backend-topics.webxml
 qtserialport/webxml/qtserialport-changes-qt6.webxml
-qtsql/webxml/database.webxml
 qtsql/webxml/qtsql-changes-qt6.webxml
 qtsql/webxml/sql-connecting.webxml
 qtsql/webxml/sql-driver.webxml
@@ -362,7 +351,6 @@ qtwidgets/webxml/qformlayout-takerowresult.webxml
 qtwidgets/webxml/qtextedit-extraselection.webxml
 qtwidgets/webxml/qtilerules.webxml
 qtwidgets/webxml/qwidget-styling.webxml
-qtwidgets/webxml/standard-dialogs.webxml
 qtwidgets/webxml/style-reference.webxml
 qtwidgets/webxml/stylesheet-customizing.webxml
 qtwidgets/webxml/stylesheet-designer.webxml
@@ -378,3 +366,18 @@ qtxml/webxml/xml-namespaces.webxml
 qtxml/webxml/xml-processing.webxml
 qtxml/webxml/xml-streaming.webxml
 qtxml/webxml/xml-tools.webxml
+
+# WebXML <group> files (lists of classes grouped by function/curated)
+[groups]
+qtcore/webxml/animation.webxml
+qtcore/webxml/events.webxml
+qtcore/webxml/io.webxml
+qtgui/webxml/painting.webxml
+qtgui/webxml/painting-3d.webxml
+qtgui/webxml/richtext-processing.webxml
+qtprintsupport/webxml/printing.webxml
+qtsql/webxml/database.webxml
+qtlocation/webxml/qml-qtlocation5-maps.webxml
+qtquick/webxml/qtquick-scenegraph-nodes.webxml
+qtquick/webxml/qtquick-scenegraph-materials.webxml
+qtnetwork/webxml/network.webxml
diff --git a/sources/pyside6/doc/extras/QtCore.rst b/sources/pyside6/doc/extras/QtCore.rst
index 0b7ac085e..b141d81a7 100644
--- a/sources/pyside6/doc/extras/QtCore.rst
+++ b/sources/pyside6/doc/extras/QtCore.rst
@@ -57,5 +57,13 @@ Additional Frameworks
 Qt Core also provides some of Qt's key frameworks.
 
     * :ref:`The Animation Framework<The-Animation-Framework>`
-    * `JSON Support in Qt <https://doc.qt.io/qt-6/json.html>`_
+    * :ref:`CBOR-Support-in-Qt`
+    * :ref:`JSON-Support-in-Qt`
     * :ref:`The Event System<The-Event-System>`
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Animation-Framework`
+    * :ref:`Event-Classes`
+    * :ref:`Input-Output-and-Networking`
diff --git a/sources/pyside6/doc/extras/QtGui.rst b/sources/pyside6/doc/extras/QtGui.rst
index 8341ff453..8eed408f6 100644
--- a/sources/pyside6/doc/extras/QtGui.rst
+++ b/sources/pyside6/doc/extras/QtGui.rst
@@ -140,3 +140,10 @@ directive:
 ::
 
     import PySide6.QtGui
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Painting-Classes`
+    * :ref:`Rendering-in-3D`
+    * :ref:`Rich-Text-Processing-APIs`
diff --git a/sources/pyside6/doc/extras/QtNetwork.rst b/sources/pyside6/doc/extras/QtNetwork.rst
index 18d8b3db2..41dcfc4d2 100644
--- a/sources/pyside6/doc/extras/QtNetwork.rst
+++ b/sources/pyside6/doc/extras/QtNetwork.rst
@@ -28,3 +28,8 @@ These articles contain information about Qt Network setup and about applications
 Also note shipping OpenSSL might cause
 `Import and Export Restrictions <https://doc.qt.io/qt-6/ssl.html#import-and-export-restrictions>`_
 to apply.
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Network-Programming-API`
diff --git a/sources/pyside6/doc/extras/QtPrintSupport.rst b/sources/pyside6/doc/extras/QtPrintSupport.rst
index 146ef6a9f..9b77199a9 100644
--- a/sources/pyside6/doc/extras/QtPrintSupport.rst
+++ b/sources/pyside6/doc/extras/QtPrintSupport.rst
@@ -13,3 +13,8 @@ directive:
 ::
 
     import PySide6.QtPrintSupport
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Printer-and-Printing-APIs`
diff --git a/sources/pyside6/doc/extras/QtSql.rst b/sources/pyside6/doc/extras/QtSql.rst
index f3374edc8..07673f294 100644
--- a/sources/pyside6/doc/extras/QtSql.rst
+++ b/sources/pyside6/doc/extras/QtSql.rst
@@ -19,3 +19,8 @@ directive:
 ::
 
     import PySide6.QtSql
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Database-Classes`
diff --git a/sources/pyside6/doc/extras/QtWidgets.rst b/sources/pyside6/doc/extras/QtWidgets.rst
index e37d90325..62d934b08 100644
--- a/sources/pyside6/doc/extras/QtWidgets.rst
+++ b/sources/pyside6/doc/extras/QtWidgets.rst
@@ -84,3 +84,8 @@ directive:
 ::
 
     import PySide6.QtWidgets
+
+List of Classes by Function
+---------------------------
+
+    * :ref:`Widgets-Classes`
author	Friedemann Kleint <Friedemann.Kleint@qt.io>	2024-12-09 18:18:20 +0100
committer	Friedemann Kleint <Friedemann.Kleint@qt.io>	2024-12-10 09:41:31 +0100
commit	d822325096a4404d4215507a673e91166ec124b6 (patch)
tree	0d88aa90df7e6a5c818f18b7832b071c5af26072 /sources/pyside6
parent	b60a27dcd43fa991ffd6a92182a0f2186d1a11ec (diff)