aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/index.rst
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-03-14 14:29:19 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-04-27 12:42:47 +0000
commit76f1ae210a14d57174c429e50df519dfe6d350d0 (patch)
tree5efe6dd8d704f7582a156d029e87620f6c46cfcc /sources/pyside2/doc/index.rst
parent4035c45e58896329e5b8b72913ff7f30d387c3dc (diff)
Doc: Add top-level index and getting started information
- Updated the copyright text in the config file - Added the copyright to the footer in the template Change-Id: Iaadc293af524abea41873d04206516caec189c53 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/index.rst')
-rw-r--r--sources/pyside2/doc/index.rst94
1 files changed, 94 insertions, 0 deletions
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
new file mode 100644
index 000000000..47437d986
--- /dev/null
+++ b/sources/pyside2/doc/index.rst
@@ -0,0 +1,94 @@
+|project|
+*************
+
+|project| enables the use of Qt 5 APIs in Python applications. It lets Python
+developers utilize the full power of Qt. The following Qt5 modules are supported:
+
+Qt Modules
+===========
+
+.. list-table::
+ :widths: 150, 150
+ :align: left
+
+ * - `Qt Core <PySide2/QtCore/index.html>`_
+ Provides core non-GUI functionality.
+ - `Qt 3D Animation <PySide2/Qt3DAnimation/index.html>`_
+ Provides basic elements required to animate 3D objects.
+ * - `Qt Gui <PySide2/QtGui/index.html>`_
+ Extends QtCore with GUI functionality.
+ - `Qt Help <PySide2/QtHelp/index.html>`_
+ Provides classes for integrating online documentation in applications.
+ * - `Qt Network <PySide2/QtNetwork/index.html>`_
+ Offers classes that lets you to write TCP/IP clients and servers.
+ - `Qt OpenGL <PySide2/QtCore/index.html>`_
+ Offers classes that make it easy to use OpenGL in Qt applications.
+ * - `Qt PrintSupport <PySide2/QtPrintSupport/index.html>`_
+ Offers classes that make it easy to use OpenGL in Qt applications.
+ - `Qt Qml <PySide2/QtQml/index.html>`_
+ Python API for Qt QML.
+ * - `Qt Charts <PySide2/QtCharts/index.html>`_
+ Provides a set of easy to use chart components.
+ - `Qt Quick <PySide2/QtQuick/index.html>`_
+ Provides classes for embedding Qt Quick in Qt applications.
+ * - `Qt DataVisualization <PySide2/QtDataVisualization/index.html>`_
+ Provides a way to visualize data in 3D as bar, scatter, and surface graphs.
+ - `Qt QuickWidgets <PySide2/QtQuickWidgets/index.html>`_
+ Provides the QQuickWidget class for embedding Qt Quick in widget-based applications.
+ * - `Qt TextToSpeech <PySide2/QtTextToSpeech/index.html>`_
+ Provides API to access text-to-speech engines.
+ - `Qt Sql <PySide2/QtSql/index.html>`_
+ Helps you provide seamless database integration to your Qt applications.
+ * - `Qt Multimedia <PySide2/QtMultimedia/index.html>`_
+ Provides low-level multimedia functionality.
+ - `Qt MultimediaWidgets <PySide2/QtMultimediaWidgets/index.html>`_
+ Provides the widget-based multimedia API.
+ * - `Qt MacExtras <PySide2/QtMacExtras/index.html>`_
+ Provides classes and functions specific to
+ macOS and iOS operating systems.
+ - `Qt Svg <PySide2/QtSvg/index.html>`_
+ Provides classes for displaying the contents of SVG files.
+ * - `Qt UiTools <PySide2/QtUiTools/index.html>`_
+ Provides classes to handle forms created with Qt Designer.
+ - `Qt Test <PySide2/QtTest/index.html>`_
+ Provides classes for unit testing Qt applications and libraries.
+ * - `Qt Concurrent <PySide2/QtConcurrent/index.html>`_
+ 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>`_
+ Provides QAxObject and QAxWidget which act as
+ containers for COM objects and ActiveX controls.
+ * - `Qt WebChannel <PySide2/QtWebChannel/index.html>`_
+ Enables peer-to-peer communication between a server and a client
+ (HTML/JavaScript or QML application).
+ - `Qt WebSockets <PySide2/QtWebSockets/index.html>`_
+ 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>`_
+ Extends Qt GUI with C++ widget functionality.
+ - `Qt WinExtras <PySide2/QtWinExtras/index.html>`_
+ Provides classes and functions for using some Windows APIs in a Qt way.
+ * - `Qt X11Extras <PySide2/QtX11Extras/index.html>`_
+ Provides information about the X display configuration.
+ - `Qt Xml <PySide2/QtXml/index.html>`_
+ Provides a stream reader and writer for XML documents.
+ * - `Qt XmlPatterns <PySide2/QtXmlPatterns/index.html>`_
+ Provides support for XPath, XQuery, XSLTi, and XML Schema validation.
+ - `Qt 3D Core <PySide2/Qt3DCore/index.html>`_
+ Contains functionality to support near-realtime simulation systems.
+ * - `Qt 3D Extras <PySide2/Qt3DExtras/index.html>`_
+ Provides a set of prebuilt elements to help you get started with Qt 3D.
+ - `Qt 3D Input <PySide2/Qt3DInput/index.html>`_
+ Provides classes for handling user input in applications using Qt 3D.
+ * - `Qt 3D Logic <PySide2/Qt3DLogic/index.html>`_
+ Enables synchronizing frames with the Qt 3D backend.
+ - `Qt 3D Render <PySide2/Qt3DRender/index.html>`_
+ Contains functionality to support 2D and 3D rendering using Qt 3D.
+
+
+.. toctree::
+ :maxdepth: 2
+
+ contents.rst