From 783b1e3fdde98ad4da6c5576728d7b047e8d6219 Mon Sep 17 00:00:00 2001 From: Kavindra Palaraja Date: Thu, 7 Nov 2019 11:53:08 +0100 Subject: docs: Propose new structure for API index Change-Id: If2d96afbf93f153fb1b8e79f150a934620899d18 Reviewed-by: Friedemann Kleint --- sources/pyside2/doc/api.rst | 94 ++++++++++++++++++++++++++----------------- sources/pyside2/doc/index.rst | 2 +- 2 files changed, 59 insertions(+), 37 deletions(-) (limited to 'sources/pyside2') diff --git a/sources/pyside2/doc/api.rst b/sources/pyside2/doc/api.rst index 2cc258c75..337d383b4 100644 --- a/sources/pyside2/doc/api.rst +++ b/sources/pyside2/doc/api.rst @@ -5,64 +5,86 @@ Basic modules ------------- - These are the main modules that will help you build a Widget based UI. - :mod:`Qt Core ` - Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc. - :mod:`Qt GUI ` - Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images. - :mod:`Qt Widgets ` - Ready to use Widgets for your application, including also graphical elements for your UI. +These are the main modules that help you build a Widget-based UI. + ++---------------------------------------+--------------------------------------------------------+ +| :mod:`Qt Core ` | Provides core non-GUI functionality, like signal and | +| | slots, properties, base classes of item models, | +| | serialization, and more. | ++---------------------------------------+--------------------------------------------------------+ +| :mod:`Qt GUI ` | Extends QtCore with GUI functionality: Events, windows | +| | and screens, OpenGL and raster-based 2D painting, as | +| | well as images. | ++---------------------------------------+--------------------------------------------------------+ +| :mod:`Qt Widgets ` | Provides ready to use Widgets for your application, | +| | including graphical elements for your UI. | ++---------------------------------------+--------------------------------------------------------+ QML and Qt Quick ---------------- - If you want to use the `QML Language `, these - modules will help you interact with it from Python. - :mod:`Qt QML ` - Base Python API to interact with the QML module. - :mod:`Qt Quick ` - Provides classes for embedding Qt Quick in Qt applications. - :mod:`Qt QuickWidgets ` - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. +Use these modules to interact with the `QML Language `, +from Python. + ++-------------------------------------------------+----------------------------------------------+ +| :mod:`Qt QML ` | The base Python API to interact with the | +| | module. | ++-------------------------------------------------+----------------------------------------------+ +| :mod:`Qt Quick ` | Provides classes to embed Qt Quick in Qt | +| | applications. | ++-------------------------------------------------+----------------------------------------------+ +| :mod:`Qt QuickWidgets ` | Provides the QQuickWidget class to embed Qt | +| | Quick in widget-based applications. | ++-------------------------------------------------+----------------------------------------------+ Data visualization ------------------ - Charts and diagrams: these modules provide a large amount - of classes that can help you include these elements in your UI. +Charts, diagrams, animations: these modules provide classes to help you include these elements in +your UI. - :mod:`Qt Charts ` - Provides a set of easy to use chart components. - :mod:`Qt DataVisualization ` - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. ++------------------------------------------------------------+-----------------------------------+ +| :mod:`Qt Charts ` | Provides a set of easy to use | +| | chart components. | ++------------------------------------------------------------+-----------------------------------+ +| :mod:`Qt DataVisualization ` | Provides a way to visualize data | +| | in 3D as bar, scatter, or surface | +| | graphs. | ++------------------------------------------------------------+-----------------------------------+ Multimedia ----------- - Audio, video, and hardware interaction: check these modules if you are - looking for multimedia solutions. +Audio, video, and hardware interaction: use these modules for multimedia solutions. - :mod:`Qt Multimedia ` - Provides low-level multimedia functionality. - :mod:`Qt MultimediaWidgets ` - Provides the widget-based multimedia API. ++------------------------------------------------------------+-----------------------------------+ +| :mod:`Qt Multimedia ` | Provides low-level multimedia | +| | functionality. | ++------------------------------------------------------------+-----------------------------------+ +| :mod:`Qt MultimediaWidgets ` | Provides the widget-based | +| | multimedia API. | ++------------------------------------------------------------+-----------------------------------+ 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. +If your project is based on a browser or the features around Web-based applications, use these +modules to interact with them. - :mod:`Qt WebEngineWidgets ` - Provides widgets that can handle web content. - :mod:`Qt WebChannel ` - Enables peer-to-peer communication between a server and a client - (HTML/JavaScript or QML application). ++---------------------------------------------------------+--------------------------------------+ +| :mod:`Qt WebEngineWidgets ` | Provides widgets to handle Web | +| | content. | ++---------------------------------------------------------+--------------------------------------+ +| :mod:`Qt WebChannel ` | Enables peer-to-peer communication | +| | between a server and a client | +| | (HTML/JavaScript or QML application).| ++---------------------------------------------------------+--------------------------------------+ All the modules --------------- - Here is a complete list of modules supported by |pymodname|. +There are many other modules currently supported by |pymodname|, here you can find a complete list +of them. - :doc:`Modules ` + :doc:`Check all the modules ` diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index 93e3451c5..96cbf2ab2 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -2,7 +2,7 @@ ********* **Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_), -enabling the use of its APIs in Python applications, and a binding generator tool (`Shiboken2`_) +so that you can use Qt5 APIs in your Python applications, and a binding generator tool (`Shiboken2`_) which can be used to expose C++ projects into Python. |project| is available under the LGPLv3/GPLv3 and the Qt commercial license. -- cgit v1.2.3 From df7c519dc5677134badd5a1cd1d2fe6b1f0b4573 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Fri, 3 Jan 2020 16:14:36 +0100 Subject: Doc: Update toctree to include only the module index The index adds all the class reference docs to the toctree so we don't need to include everything under the module directory. Change-Id: I6ef20914a63a1f246b06b2725435a4fc42deaf9b Reviewed-by: Friedemann Kleint Reviewed-by: Paul Wicking --- sources/pyside2/doc/modules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'sources/pyside2') diff --git a/sources/pyside2/doc/modules.rst b/sources/pyside2/doc/modules.rst index d9accd664..bb4b112a1 100644 --- a/sources/pyside2/doc/modules.rst +++ b/sources/pyside2/doc/modules.rst @@ -5,7 +5,7 @@ Qt Modules :hidden: :glob: - PySide2/Qt*/* + PySide2/Qt*/index .. list-table:: :widths: 150, 150 -- cgit v1.2.3