From 09ab4662bae4641ab26023567a765077243f162c Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Tue, 30 Jan 2018 12:39:53 +0100 Subject: Update documentation HTML templates - Fix some URLs - Add modules new in Qt 5 - Remove outdated modules - Remove outdated copyright URLs Task-number: PYSIDE-363 Change-Id: Iebdf0ee89db9f637a7317e199d71e164814c8f49 Reviewed-by: Alexandru Croitor --- sources/pyside2/doc/_templates/index.html | 94 +++++++++++++++++++++++-------- 1 file changed, 72 insertions(+), 22 deletions(-) (limited to 'sources/pyside2/doc/_templates/index.html') diff --git a/sources/pyside2/doc/_templates/index.html b/sources/pyside2/doc/_templates/index.html index 8da417682..901ddc496 100644 --- a/sources/pyside2/doc/_templates/index.html +++ b/sources/pyside2/doc/_templates/index.html @@ -4,18 +4,19 @@

PySide {{ version }} Reference

-

Qt is a cross-platform application framework from Qt Software (owned by Nokia). - It features a large number of libraries providing services like network abstraction and XML handling, along with a very rich - GUI package, allowing C++ developers to write their applications once and run them unmodified in different systems. +

Qt is a complete cross-platform software framework. PySide aims to provide Python developers access to the Qt libraries in the most natural way.

-

PySide is built using the Shiboken binding generator.

+

PySide is built using the Shiboken binding generator.

Notes

About 0 vs None

-

The PySide class reference documentation is automatically generated from the original Qt documentation for C++, some parts were tuned to fit the Python world. However, it's not possible to rewrite all Qt docs as it would require a really huge effort, so if the documentation says you can use 0 on an QObject argument, interpret it as None.

+

The PySide class reference documentation is automatically generated from the original + Qt documentation for C++, some parts were tuned to fit the Python world. However, it's not + possible to rewrite all Qt docs as it would require a really huge effort, so if the + documentation says you can use 0 on an QObject argument, interpret it as None.

About keyword arguments

@@ -25,34 +26,83 @@
-

QtCore
+

Qt3DAnimation
+ provides a set of prebuilt elements to help you get started with Qt 3D

+

Qt3DCore
+ contains functionality to support near-realtime simulation systems

+

Qt3DExtras
+ provides a set of prebuilt elements to help you get started with Qt 3D

+

Qt3DInput
+ provides classes for handling user input in applications using Qt3D

+

Qt3DLogic
+ enables synchronizing frames with the Qt 3D backend

+

Qt3DRender
+ contains functionality to support 2D and 3D rendering using Qt 3D

+

QtAxContainer
+ provides QAxObject and QAxWidget which act as + containers for COM objects and ActiveX controls

+

QtCharts
+ provides a set of easy to use chart components

+

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

+

QtCore
core non-GUI functionality

-

QtGui
+

QtDataVisualization
+ provides a way to visualize data in 3D as bar, scatter, and surface graphs

+

QtGui
extends QtCore with GUI functionality.

-

QtHelp
+

QtMacExtras
+ provides classes and functions specific to + macOS and iOS operating systems

+

QtHelp
provides classes for integrating online documentation in applications

-

QtMultimedia
+

QtMultimedia
provides low-level multimedia functionality

-

QtNetwork
+

QtMultimediaWidgets
+ provides the widget-based multimedia API

+

QtNetwork
offers classes that allow you to write TCP/IP clients and servers

-

QtOpenGL
- offers classes that make it easy to use OpenGL in Qt applications

-

QtScript
- provides classes for making Qt applications scriptable

 -

QtScriptTools
- provides additional components for applications that use Qt Script

-

QtSql
+

QtOpenGL
+ offers classes that make it easy to use OpenGL in Qt applications

+

QtPrintSupport
+ provides cross-platform support for printing

+

QtQml
+ Python API for Qt QML

+

QtQuick
+ provides classes for embedding Qt Quick in Qt applications

+

QtQuickWidgets
+ provides the QQuickWidget class for embedding Qt Quick in widget-based applications

+

QtTextToSpeech
+ provides C++ API to access text-to-speech engines

+

QtSql
helps you provide seamless database integration to your Qt applications

-

QtSvg
+

QtSvg
provides classes for displaying the contents of SVG files

-

QtUiTools
+

QtTest
+ provides classes for unit testing Qt applications and libraries

+

QtUiTools
provides classes to handle forms created with Qt Designer

-

QtXml
+

QtWebChannel
+ enables peer-to-peer communication between a server and a client + (HTML/JavaScript or QML application)

+

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

+

QtWidgets
+ extends Qt GUI with C++ widget functionality.

+

QtWinExtras
+ provides classes and functions for using some Windows APIs in a Qt way

+

QtX11Extras
+ provides information about the X display configuration

+

QtXml
provides a stream reader and writer for XML documents

-

QtWebkit
- provides a Web browser engine

+

QtXmlPatterns
+ provides support for XPath, XQuery, XSLT and XML Schema validation

-- cgit v1.2.3