diff options
| -rw-r--r-- | sources/pyside2/doc/contents.rst | 1 | ||||
| -rw-r--r-- | sources/pyside2/doc/index.rst | 28 | ||||
| -rw-r--r-- | sources/pyside2/doc/modules.rst | 87 | ||||
| -rw-r--r-- | sources/pyside2/doc/overview.rst | 14 |
4 files changed, 76 insertions, 54 deletions
diff --git a/sources/pyside2/doc/contents.rst b/sources/pyside2/doc/contents.rst index 675a5b73a..c4867f250 100644 --- a/sources/pyside2/doc/contents.rst +++ b/sources/pyside2/doc/contents.rst @@ -11,6 +11,7 @@ deployment.rst pysideapi2.rst licenses.rst + modules.rst Module Index ============ diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index b0bb1d19c..acc1d6d40 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -24,23 +24,23 @@ Basic modules ------------- These are the main modules that will help you build a Widget based UI. - `Qt Core <PySide2/QtCore/index.html>`_ + :mod:`Qt Core <PySide2.QtCore>` Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc. - `Qt Gui <PySide2/QtGui/index.html>`_ + :mod:`Qt Gui <PySide2.QtGui>` Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images. - `Qt Widgets <PySide2/QtWidgets/index.html>`_ + :mod:`Qt Widgets <PySide2.QtWidgets>` Ready to use Widgets for your application, including also graphical elements for your UI. QML and Qt Quick ---------------- - If you want to use the `Qml Language <https://doc.qt.io/qt-5/qmlapplications.html>`, these + If you want to use the `Qml Language <https://doc.qt.io/qt-5.qmlapplications>`, these modules will help you interact with it from Python. - `Qt Qml <PySide2/QtQml/index.html>`_ + :mod:`Qt Qml <PySide2.QtQml>` Base Python API to interact with the QML module. - `Qt Quick <PySide2/QtQuick/index.html>`_ + :mod:`Qt Quick <PySide2.QtQuick>` Provides classes for embedding Qt Quick in Qt applications. - `Qt QuickWidgets <PySide2/QtQuickWidgets/index.html>`_ + :mod:`Qt QuickWidgets <PySide2.QtQuickWidgets>` Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. Data visualization @@ -49,9 +49,9 @@ Data visualization Charts, diagrams, animations: these modules provide a large amount of classes that can help you include these elements in your UI. - `Qt Charts <PySide2/QtCharts/index.html>`_ + :mod:`Qt Charts <PySide2.QtCharts>` Provides a set of easy to use chart components. - `Qt DataVisualization <PySide2/QtDataVisualization/index.html>`_ + :mod:`Qt DataVisualization <PySide2.QtDataVisualization>` Provides a way to visualize data in 3D as bar, scatter, and surface graphs. Multimedia @@ -60,9 +60,9 @@ Multimedia Audio, video, and hardware interaction: check these modules if you are looking for multimedia solutions. - `Qt Multimedia <PySide2/QtMultimedia/index.html>`_ + :mod:`Qt Multimedia <PySide2.QtMultimedia>` Provides low-level multimedia functionality. - `Qt MultimediaWidgets <PySide2/QtMultimediaWidgets/index.html>`_ + :mod:`Qt MultimediaWidgets <PySide2.QtMultimediaWidgets>` Provides the widget-based multimedia API. WebEngine @@ -71,9 +71,9 @@ WebEngine If your project is based on a browser or the features around web based applications, these modules will help you to interact with them. - `Qt WebEngineWidgets <PySide2/QtWebEngineWidgets/index.html>`_ + :mod:`Qt WebEngineWidgets <PySide2.QtWebEngineWidgets>` Provides widgets that can handle web content. - `Qt WebChannel <PySide2/QtWebChannel/index.html>`_ + :mod:`Qt WebChannel <PySide2.QtWebChannel>` Enables peer-to-peer communication between a server and a client (HTML/JavaScript or QML application). @@ -83,5 +83,5 @@ All the modules There are many other modules currently supported by |pymodname|, here you can find a complete list of them. - `Check all the modules <modules.html>`_ + :doc:`Check all the modules <modules>` Display a table with all the currently supported Qt modules. diff --git a/sources/pyside2/doc/modules.rst b/sources/pyside2/doc/modules.rst index 1d6564300..6741b465d 100644 --- a/sources/pyside2/doc/modules.rst +++ b/sources/pyside2/doc/modules.rst @@ -1,94 +1,101 @@ Qt Modules =========== +.. toctree:: + :hidden: + :glob: + + PySide2/Qt** + .. list-table:: :widths: 150, 150 :align: left - * - `Qt Core <PySide2/QtCore/index.html>`_ + * - :mod:`Qt Core <PySide2.QtCore>` Provides core non-GUI functionality. - - `Qt 3D Animation <PySide2/Qt3DAnimation/index.html>`_ + - :mod:`Qt 3D Animation <PySide2.Qt3DAnimation>` Provides basic elements required to animate 3D objects. - * - `Qt Gui <PySide2/QtGui/index.html>`_ + * - :mod:`Qt Gui <PySide2.QtGui>` Extends QtCore with GUI functionality. - - `Qt Help <PySide2/QtHelp/index.html>`_ + - :mod:`Qt Help <PySide2.QtHelp>` Provides classes for integrating online documentation in applications. - * - `Qt Network <PySide2/QtNetwork/index.html>`_ + * - :mod:`Qt Network <PySide2.QtNetwork>` Offers classes that let you to write TCP/IP clients and servers. - - `Qt OpenGL <PySide2/QtOpenGL/index.html>`_ + - :mod:`Qt OpenGL <PySide2.QtOpenGL>` Offers classes that make it easy to use OpenGL in Qt applications. - * - `Qt PrintSupport <PySide2/QtPrintSupport/index.html>`_ + * - :mod:`Qt PrintSupport <PySide2.QtPrintSupport>` Provides extensive cross-platform support for printing. - - `Qt Qml <PySide2/QtQml/index.html>`_ + - :mod:`Qt Qml <PySide2.QtQml>` Python API for Qt QML. - * - `Qt Charts <PySide2/QtCharts/index.html>`_ + * - :mod:`Qt Charts <PySide2.QtCharts>` Provides a set of easy to use chart components. - - `Qt Quick <PySide2/QtQuick/index.html>`_ + - :mod:`Qt Quick <PySide2.QtQuick>` Provides classes for embedding Qt Quick in Qt applications. - * - `Qt DataVisualization <PySide2/QtDataVisualization/index.html>`_ + * - :mod:`Qt DataVisualization <PySide2.QtDataVisualization>` Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - - `Qt QuickWidgets <PySide2/QtQuickWidgets/index.html>`_ + - :mod:`Qt QuickWidgets <PySide2.QtQuickWidgets>` Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - * - `Qt TextToSpeech <PySide2/QtTextToSpeech/index.html>`_ + * - :mod:`Qt TextToSpeech <PySide2.QtTextToSpeech>` Provides API to access text-to-speech engines. - - `Qt Sql <PySide2/QtSql/index.html>`_ + - :mod:`Qt Sql <PySide2.QtSql>` Helps you provide seamless database integration to your Qt applications. - * - `Qt Multimedia <PySide2/QtMultimedia/index.html>`_ + * - :mod:`Qt Multimedia <PySide2.QtMultimedia>` Provides low-level multimedia functionality. - - `Qt MultimediaWidgets <PySide2/QtMultimediaWidgets/index.html>`_ + - :mod:`Qt MultimediaWidgets <PySide2.QtMultimediaWidgets>` Provides the widget-based multimedia API. - * - `Qt MacExtras <PySide2/QtMacExtras/index.html>`_ + * - :mod:`Qt MacExtras <PySide2.QtMacExtras>` Provides classes and functions specific to macOS and iOS operating systems. - - `Qt Svg <PySide2/QtSvg/index.html>`_ + - :mod:`Qt Svg <PySide2.QtSvg>` Provides classes for displaying the contents of SVG files. - * - `Qt UiTools <PySide2/QtUiTools/index.html>`_ + * - :mod:`Qt UiTools <PySide2.QtUiTools>` Provides classes to handle forms created with Qt Designer. - - `Qt Test <PySide2/QtTest/index.html>`_ + - :mod:`Qt Test <PySide2.QtTest>` Provides classes for unit testing Qt applications and libraries. - * - `Qt Concurrent <PySide2/QtConcurrent/index.html>`_ + * - :mod:`Qt Concurrent <PySide2.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. - - `Qt AxContainer <PySide2/QtAxContainer/index.html>`_ + - :mod:`Qt AxContainer <PySide2.QtAxContainer>` Provides QAxObject and QAxWidget which act as containers for COM objects and ActiveX controls. - * - `Qt WebEngineCore <PySide2/QtWebEngineCore/index.html>`_ + * - :mod:`Qt WebEngineCore <PySide2.QtWebEngineCore>` Provides the core functionality to integrate web content. - - `Qt WebEngineWidgets <PySide2/QtWebEngineWidgets/index.html>`_ + - :mod:`Qt WebEngineWidgets <PySide2.QtWebEngineWidgets>` Provides widgets that can handle web content. - * - `Qt WebChannel <PySide2/QtWebChannel/index.html>`_ + * - :mod:`Qt WebChannel <PySide2.QtWebChannel>` Enables peer-to-peer communication between a server and a client (HTML/JavaScript or QML application). - - `Qt WebSockets <PySide2/QtWebSockets/index.html>`_ + - :mod:`Qt WebSockets <PySide2.QtWebSockets>` Provides interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both. - * - `Qt Widgets <PySide2/QtWidgets/index.html>`_ + * - :mod:`Qt Widgets <PySide2.QtWidgets>` Extends Qt GUI with C++ widget functionality. - - `Qt WinExtras <PySide2/QtWinExtras/index.html>`_ + - :mod:`Qt WinExtras <PySide2.QtWinExtras>` Provides classes and functions for using some Windows APIs in a Qt way. - * - `Qt X11Extras <PySide2/QtX11Extras/index.html>`_ + * - :mod:`Qt X11Extras <PySide2.QtX11Extras>` Provides information about the X display configuration. - - `Qt Xml <PySide2/QtXml/index.html>`_ + - :mod:`Qt Xml <PySide2.QtXml>` Provides C++ implementations of SAX and DOM. - * - `Qt XmlPatterns <PySide2/QtXmlPatterns/index.html>`_ + * - :mod:`Qt XmlPatterns <PySide2.QtXmlPatterns>` Provides support for XPath, XQuery, XSLTi, and XML Schema validation. - - `Qt 3D Core <PySide2/Qt3DCore/index.html>`_ + - :mod:`Qt 3D Core <PySide2.Qt3DCore>` Contains functionality to support near-realtime simulation systems. - * - `Qt 3D Extras <PySide2/Qt3DExtras/index.html>`_ + * - :mod:`Qt 3D Extras <PySide2.Qt3DExtras>` Provides a set of prebuilt elements to help you get started with Qt 3D. - - `Qt 3D Input <PySide2/Qt3DInput/index.html>`_ + - :mod:`Qt 3D Input <PySide2.Qt3DInput>` Provides classes for handling user input in applications using Qt 3D. - * - `Qt 3D Logic <PySide2/Qt3DLogic/index.html>`_ + * - :mod:`Qt 3D Logic <PySide2.Qt3DLogic>` Enables synchronizing frames with the Qt 3D backend. - - `Qt 3D Render <PySide2/Qt3DRender/index.html>`_ + - :mod:`Qt 3D Render <PySide2.Qt3DRender>` Contains functionality to support 2D and 3D rendering using Qt 3D. - * - `Qt Positioning <PySide2/QtPositioning/index.html>`_ + * - :mod:`Qt Positioning <PySide2.QtPositioning>` Provides positioning information via QML and Python interfaces. - - `Qt Location <PySide2/QtLocation/index.html>`_ + - :mod:`Qt Location <PySide2.QtLocation>` Helps you create viable mapping solutions using the data available from some of the popular location services. - * - `Qt Sensors <PySide2/QtSensors/index.html>`_ + * - :mod:`Qt Sensors <PySide2.QtSensors>` Provides access to sensor hardware via QML and Python interfaces and a motion gesture recognition API for devices. - - `Qt Scxml <PySide2/QtScxml/index.html>`_ + - :mod:`Qt Scxml <PySide2.QtScxml>` Provides classes to create and use state machines from SCXML files. + diff --git a/sources/pyside2/doc/overview.rst b/sources/pyside2/doc/overview.rst index e8a8ace00..86c3a54fe 100644 --- a/sources/pyside2/doc/overview.rst +++ b/sources/pyside2/doc/overview.rst @@ -40,3 +40,17 @@ A simple Hello World example in PySide2 looks like this: label = QLabel("Hello World") label.show() sys.exit(app.exec_()) + + +Additional overviews +-------------------- + +These additional topics provide detailed information about +several Qt-specific features: + +.. toctree:: + :titlesonly: + :glob: + + overviews/* + |