aboutsummaryrefslogtreecommitdiffstats
path: root/sources
diff options
context:
space:
mode:
authorKavindra Palaraja <kpalaraja@luxoft.com>2019-11-07 11:50:41 +0100
committerKavindra Palaraja <kpalaraja@luxoft.com>2019-11-27 11:17:50 +0100
commita707b24f58464eec20e8905e2e742efc753a70ea (patch)
tree3d6664efbf3c8b0b71720cd8ba211ba48b19b5be /sources
parentc3480ed33935c81a0d5687b2bfb65cb59d857886 (diff)
docs: Propose new structure for overview
Change-Id: I4a946cc0373f986db422439b1796fdddbf0ae35b Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources')
-rw-r--r--sources/pyside2/doc/overview.rst40
1 files changed, 4 insertions, 36 deletions
diff --git a/sources/pyside2/doc/overview.rst b/sources/pyside2/doc/overview.rst
index 86c3a54fe..88f03c4eb 100644
--- a/sources/pyside2/doc/overview.rst
+++ b/sources/pyside2/doc/overview.rst
@@ -1,12 +1,11 @@
Overview
=========
-The |project| project aims to provide a complete port of the PySide module to Qt 5.
-The development started on GitHub in May 2015. The project managed to port Pyside to
-Qt 5.3, 5. 4 & 5.5.
+The |project| project provides a complete port of the PySide module to Qt 5. Development started on
+GitHub in May 2015. Since then, the project has ported PySide to Qt 5.3, 5.4, and 5.5.
-The `PySide2` module was released mid June 2018 as a Technical Preview (supporting Qt 5.11),
-and it has been fully supported since Qt 5.12.
+In June 2018, the `PySide2` module was released as a Technical Preview (supporting Qt 5.11); it's
+been fully supported since Qt 5.12.
|project| is available under LGPLv3/GPLv2 and commercial license for the following platforms:
@@ -23,34 +22,3 @@ and it has been fully supported since Qt 5.12.
* (*): `No Qt release <https://wiki.qt.io/Qt_5.12_Tools_and_Versions#Software_configurations_for_Qt_5.12.0>`_
* (**): `MSVC issue with Python 2.7 and Qt <https://wiki.qt.io/Qt_for_Python/Considerations#Missing_Windows_.2F_Python_2.7_release>`_
-
-What does PySide2 look like?
-----------------------------
-
-A simple Hello World example in PySide2 looks like this:
-
-::
-
- import sys
- from PySide2.QtWidgets import QApplication, QLabel
-
-
- if __name__ == "__main__":
- app = QApplication(sys.argv)
- 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/*
-