diff options
Diffstat (limited to 'sources/pyside2/doc/index.rst')
| -rw-r--r-- | sources/pyside2/doc/index.rst | 147 |
1 files changed, 82 insertions, 65 deletions
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index acc1d6d40..6c62334d5 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -1,87 +1,104 @@ |project| -************* +********* -|project| offers Python bindings for Qt, enabling the use of Qt5 APIs in Python -applications. It lets Python developers utilize the full potential of Qt, using -the |pymodname| module. +.. ifconfig:: output_format == 'html' -The |pymodname| module provides access to the individual -Qt modules such as QtCore, QtGui, and so on. |project| also comes with the -:doc:`Shiboken2 <shiboken2:index>` CPython binding code generator, which can be -used to generate Python bindings for your C or C++ code. + **Qt for Python** offers the official Python bindings for `Qt`_, and + has two main components: -.. toctree:: - :name: mastertoc - :maxdepth: 2 + * `PySide2`_, so that you can use Qt5 APIs in your Python applications, and + * `Shiboken2 <shiboken2/index.html>`__, a binding generator tool, which can + be used to expose C++ projects to Python, and a Python module with + some utility functions. + +.. ifconfig:: output_format == 'qthelp' + + **Qt for Python** offers the official Python bindings for `Qt`_, and + has two main components: - contents.rst - Known issues <https://wiki.qt.io/Qt_for_Python/Considerations> + * `PySide2`_, so that you can use Qt5 APIs in your Python applications, and + * `Shiboken2 <../shiboken2/index.html>`__, a binding generator tool, which can + be used to expose C++ projects to Python, and a Python module with + some utility functions. -Qt Modules -=========== +This project is available under the LGPLv3/GPLv3 and the `Qt commercial license`_. -Basic modules -------------- - These are the main modules that will help you build a Widget based UI. +.. _Qt: https://doc.qt.io +.. _PySide2: quickstart.html +.. _`Qt commercial license`: https://www.qt.io/licensing/ - :mod:`Qt Core <PySide2.QtCore>` - Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc. - :mod:`Qt Gui <PySide2.QtGui>` - Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images. - :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>`, these - modules will help you interact with it from Python. - :mod:`Qt Qml <PySide2.QtQml>` - Base Python API to interact with the QML module. - :mod:`Qt Quick <PySide2.QtQuick>` - Provides classes for embedding Qt Quick in Qt applications. - :mod:`Qt QuickWidgets <PySide2.QtQuickWidgets>` - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. +Documentation +============= -Data visualization ------------------- +.. ifconfig:: output_format == 'html' - Charts, diagrams, animations: these modules provide a large amount - of classes that can help you include these elements in your UI. + .. raw:: html - :mod:`Qt Charts <PySide2.QtCharts>` - Provides a set of easy to use chart components. - :mod:`Qt DataVisualization <PySide2.QtDataVisualization>` - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. + <table class="special"> + <colgroup> + <col style="width: 33%" /> + <col style="width: 33%" /> + <col style="width: 33%" /> + </colgroup> + <tr> + <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td> + <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td> + <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td> + </tr> -Multimedia ------------ + <tr> + <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td> + <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td> + <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td> + </tr> - Audio, video, and hardware interaction: check these modules if you are - looking for multimedia solutions. + <tr> + <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td> + <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td> + <td><a href="shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td> + </tr> + </table> - :mod:`Qt Multimedia <PySide2.QtMultimedia>` - Provides low-level multimedia functionality. - :mod:`Qt MultimediaWidgets <PySide2.QtMultimediaWidgets>` - Provides the widget-based multimedia API. +.. ifconfig :: output_format == 'qthelp' -WebEngine ---------- + .. raw:: html - If your project is based on a browser or the features around web - based applications, these modules will help you to interact with them. + <table class="special"> + <colgroup> + <col style="width: 33%" /> + <col style="width: 33%" /> + <col style="width: 33%" /> + </colgroup> + <tr> + <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td> + <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td> + <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td> + </tr> - :mod:`Qt WebEngineWidgets <PySide2.QtWebEngineWidgets>` - Provides widgets that can handle web content. - :mod:`Qt WebChannel <PySide2.QtWebChannel>` - Enables peer-to-peer communication between a server and a client - (HTML/JavaScript or QML application). + <tr> + <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td> + <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td> + <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td> + </tr> -All the modules ---------------- + <tr> + <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td> + <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td> + <td><a href="../shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td> + </tr> + </table> - There are many other modules currently supported by |pymodname|, - here you can find a complete list of them. +We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community. + +.. _`wiki page`: https://wiki.qt.io/Qt_for_Python + +.. toctree:: + :hidden: + :glob: - :doc:`Check all the modules <modules>` - Display a table with all the currently supported Qt modules. + contents.rst + gettingstarted* + pyside-examples/pyside2examples* + overviews/* |