blob: de031b96bb4610d984a50992cd5967f08404d561 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
Shiboken
********
.. ifconfig:: output_format == 'html'
Shiboken is a fundamental piece on the `Qt for Python <../index.html>`__ project that serves two purposes:
.. ifconfig:: output_format == 'qthelp'
Shiboken is a fundamental piece on the `Qt for Python <../pyside6/index.html>`__ project that serves two purposes:
* Generator_: Extract information from C or C++ headers and generate CPython_ code that allow
to bring C or C++ projects to Python. This process uses a library called ApiExtractor_ which
internally uses Clang_.
* Module_: An utility Python module that exposed new Python types, functions to handle pointers,
among other things, that is written in CPython_ and can use independently of the generator.
.. _Generator: shibokengenerator.html
.. _Module: shibokenmodule.html
.. _CPython: https://github.com/python/cpython
.. _Clang: https://clang.llvm.org/
.. _ApiExtractor: typesystem.html
Documentation
=============
.. grid:: 1 3 3 3
:gutter: 2
.. grid-item-card::
:class-item: text-center
Install and build from source.
+++
.. button-ref:: gettingstarted
:color: primary
:outline:
:expand:
Getting Started
.. grid-item-card::
:class-item: text-center
Binding generator executable.
+++
.. button-ref:: shibokengenerator
:color: primary
:outline:
:expand:
Shiboken Generator
.. grid-item-card::
:class-item: text-center
Python utility module.
+++
.. button-ref:: shibokenmodule
:color: primary
:outline:
:expand:
Shiboken Module
.. grid-item-card::
:class-item: text-center
Reference and functionality.
+++
.. button-ref:: typesystem
:color: primary
:outline:
:expand:
Type System
.. grid-item-card::
:class-item: text-center
Using Shiboken.
+++
.. button-ref:: examples/index
:color: primary
:outline:
:expand:
Examples
.. grid-item-card::
:class-item: text-center
Generating Python stub files.
+++
.. button-ref:: shiboken-genpyi
:color: primary
:outline:
:expand:
shiboken6-genpyi
.. grid-item-card::
:class-item: text-center
Known issues and FAQ.
+++
.. button-ref:: considerations
:color: primary
:outline:
:expand:
Considerations
.. toctree::
:hidden:
:glob:
gettingstarted.rst
shibokengenerator.rst
shibokenmodule.rst
typesystem.rst
examples/index.rst
shiboken-genpyi.rst
considerations.rst
|
