summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-12-11 11:06:38 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2018-12-12 09:54:03 +0000
commita5a9455a8da5505264ff3f087876fcb4f9541680 (patch)
tree9b62574e29923935a7d6e5315907bb0c8f108f98
parentebe974c8a3bacf636a17f254850d978ee4e79cf3 (diff)
Doc: Add a link to the known issues wiki page
The wiki page describes some known issues and considerations that are useful to the developers. Also, moved toctree to the top to get readers' attention, as the modules list is too long. Change-Id: Id2dcce1fe51c2c9e9eacb45e573605cc21d3a59d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
-rw-r--r--sources/pyside2/doc/index.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
index 27fefeb1..474449a6 100644
--- a/sources/pyside2/doc/index.rst
+++ b/sources/pyside2/doc/index.rst
@@ -4,7 +4,16 @@
The |project| product enables the use of Qt5 APIs in Python applications. It
lets Python developers utilize the full potential of Qt, using the |pymodname| module.
The |pymodname| module provides access to the individual Qt modules such as QtCore,
-QtGui, and so on. The following is the list of supported Qt5 modules:
+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.
+
+.. toctree::
+ :name: mastertoc
+ :maxdepth: 2
+
+ contents.rst
+ Known issues <https://wiki.qt.io/Qt_for_Python/Considerations>
Qt Modules
===========
@@ -100,11 +109,3 @@ Qt Modules
Provides access to sensor hardware via QML and Python interfaces and a motion gesture recognition API for devices.
- `Qt Scxml <PySide2/QtScxml/index.html>`_
Provides classes to create and use state machines from SCXML files.
-
-|project| also comes with the
-:doc:`Shiboken2 <shiboken2:index>` CPython binding code generator.
-
-.. toctree::
- :maxdepth: 2
-
- contents.rst