aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/doc/typesystem.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken2/doc/typesystem.rst')
-rw-r--r--sources/shiboken2/doc/typesystem.rst54
1 files changed, 45 insertions, 9 deletions
diff --git a/sources/shiboken2/doc/typesystem.rst b/sources/shiboken2/doc/typesystem.rst
index 7674129cd..0d43cec2c 100644
--- a/sources/shiboken2/doc/typesystem.rst
+++ b/sources/shiboken2/doc/typesystem.rst
@@ -1,5 +1,5 @@
Type System Reference
-*********************
+=====================
The typesystem is used by a binding generator or any other software using the APIExtractor library
to map a C++ library API onto a higher level language.
@@ -15,15 +15,51 @@ Below there is a complete reference guide to the various nodes (XML tags) of the
For usage examples, take a look at the typesystem files used to generate PySide2. These files
can be found in the PySide2/<QT_MODULE_NAME> directory of the PySide2 package.
+Define types
+------------
+
+.. toctree::
+ :maxdepth: 1
+
+ typesystem_specifying_types.rst
+
+Code generation
+---------------
+
.. toctree::
+ :maxdepth: 1
+
+ typesystem_codegeneration.rst
- typesystem_specifying_types
- typesystem_manipulating_objects
- typesystem_modify_function
- typesystem_arguments
- typesystem_solving_compilation
- typesystem_templates
- typesystem_conversionrule
- typesystem_documentation
+Modifying types
+---------------
+
+.. toctree::
+ :maxdepth: 1
+ typesystem_arguments.rst
+ typesystem_codeinjection.rst
+ typesystem_converters.rst
+ typesystem_templates.rst
+ typesystem_modify_function.rst
+ typesystem_manipulating_objects.rst
+ typesystem_conversionrule.rst
+ typesystem_documentation.rst
+ typesystem_variables.rst
+
+Object ownership
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ typesystem_ownership.rst
+
+Extra options and Python caveats
+--------------------------------
+
+.. toctree::
+ :maxdepth: 1
+ typesystem_solving_compilation.rst
+ typesystem_sequenceprotocol.rst