aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/index.rst
blob: 53dd3de3808a9ac1321575520650cdbfa69c596b (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|project|
*********

.. ifconfig:: output_format == 'html'

    **Qt for Python** offers the official Python bindings for `Qt`_, and
    has two main components:

    * `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
    * `Shiboken6 <shiboken6/index.html>`__, a binding generator tool, which can
      be used to expose C++ projects to Python, and a Python module with
      some utility functions.

.. ifconfig:: output_format == 'qthelp'

    **Qt for Python** offers the official Python bindings for `Qt`_, and
    has two main components:

    * `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
    * `Shiboken6 <../shiboken6/index.html>`__, a binding generator tool, which can
      be used to expose C++ projects to Python, and a Python module with
      some utility functions.

`Porting from PySide2 to PySide6`_ provides information on porting existing PySide2
applications.

This project is available under the LGPLv3/GPLv3 and the `Qt commercial license`_.

.. _Qt: https://doc.qt.io
.. _PySide6: quickstart.html
.. _`Qt commercial license`: https://www.qt.io/licensing/
.. _`Porting from PySide2 to PySide6`: porting_from2.html



Documentation
=============

.. ifconfig:: output_format == 'html'

    .. panels::
        :body: align-items-center jutify-content-center text-center
        :container: container-lg pb-3
        :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
        :img-top-cls: d-flex align-self-center img-responsive card-img-top-main

        :img-top: images/Desktop.svg

        Write your first Qt application.

        +++

        .. link-button:: quickstart
            :type: ref
            :text: Check it out!
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/Support.svg

        Install and build from source.

        +++

        .. link-button:: gettingstarted
            :type: ref
            :text: Getting Started
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/Dev.svg

        PySide API reference.

        +++

        .. link-button:: api
            :type: ref
            :text: API Docs
            :classes: btn-qt btn-block stretched-link

        ---
        :img-top: images/Tutorials.svg

        Learn with step-by-step guides.

        +++

        .. link-button:: tutorials/index
            :type: ref
            :text: Tutorials
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/Examples.svg

        Check all the available examples.

        +++

        .. link-button:: examples/index
            :type: ref
            :text: Examples
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/Training.svg

        Watch webinars, talks, and more.

        +++

        .. link-button:: videos
            :type: ref
            :text: Videos
            :classes: btn-qt btn-block stretched-link

        ---
        :img-top: images/Deployment.svg

        Learn to deploy your applications.

        +++

        .. link-button:: deployment-guides
            :type: ref
            :text: Deployment
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/stopwatch.svg

        API differences and known issues.

        +++

        .. link-button:: considerations
            :type: ref
            :text: Considerations
            :classes: btn-qt btn-block stretched-link
        ---
        :img-top: images/cpp_python.svg

        Generate C++ to Python bindings.

        +++

        .. link-button:: shiboken6/index.html
            :text: Shiboken
            :classes: btn-qt btn-block stretched-link

.. ifconfig:: output_format == 'qthelp'

    .. raw:: html

        <table class="special">
            <colgroup>
                <col style="width: 33%" />
                <col style="width: 33%" />
                <col style="width: 33%" />
            </colgroup>
            <tr>
                <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td>
                <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td>
                <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td>
            </tr>
            <tr>
                <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td>
                <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td>
                <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td>
            </tr>
            <tr>
                <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
                <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
                <td><a href="../shiboken6/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
            </tr>
        </table>


We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community.

.. _`wiki page`: https://wiki.qt.io/Qt_for_Python

.. toctree::
   :hidden:
   :glob:

   contents.rst
   gettingstarted*
   overviews/*
   feature-why