diff options
author | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-03-22 15:22:49 +0100 |
---|---|---|
committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-03-27 15:19:29 +0000 |
commit | ee9ead9f4ca85804f6cab977a0881458714aee3b (patch) | |
tree | d8be599d8ba5f47e7a734413b50495e833573c9f /sources/pyside2/doc/overview.rst | |
parent | 066dfadf24b64628fabe25097a86a41f62e73526 (diff) |
Doc: Add descriptions, pages, and moving modules
Having all the Qt modules on the main page is too verbose.
I created four sections with a couple of them and added
more context to clarify when to use them.
All the modules are still listed in a new page called `modules`.
I included an `overview` page with some general information from
our wiki: compatibility among platforms, an example and the FAQ.
Task-number: PYSIDE-691
Change-Id: Ic9e2519aa2caa9c8a645633c2c1772e4844b5ec5
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/overview.rst')
-rw-r--r-- | sources/pyside2/doc/overview.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/sources/pyside2/doc/overview.rst b/sources/pyside2/doc/overview.rst new file mode 100644 index 000000000..e8a8ace00 --- /dev/null +++ b/sources/pyside2/doc/overview.rst @@ -0,0 +1,42 @@ +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 `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. + +|project| is available under LGPLv3/GPLv2 and commercial license for the following platforms: + ++-------------+--------+--------+--------+--------+---------+---------+ +| | Linux | macOS | Windows | ++=============+========+========+========+========+=========+=========+ +| | 32bit | 64bit | 32bit | 64bit | 32bit | 64bit | ++-------------+--------+--------+--------+--------+---------+---------+ +| Python 2.7 | No (*) | Yes | No (*) | Yes | No (**) | No (**) | ++-------------+--------+--------+--------+--------+---------+---------+ +| Python 3.5+ | No (*) | Yes | No (*) | Yes | Yes | Yes | ++-------------+--------+--------+--------+--------+---------+---------+ + + * (*): `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_()) |