diff options
Diffstat (limited to 'sources/pyside6/doc/index.rst')
| -rw-r--r-- | sources/pyside6/doc/index.rst | 222 |
1 files changed, 135 insertions, 87 deletions
diff --git a/sources/pyside6/doc/index.rst b/sources/pyside6/doc/index.rst index c982c7c3b..1bb28f9c1 100644 --- a/sources/pyside6/doc/index.rst +++ b/sources/pyside6/doc/index.rst @@ -3,8 +3,9 @@ .. ifconfig:: output_format == 'html' - **Qt for Python** offers the official Python bindings for `Qt`_, and - has two main components: + **Qt for Python** offers the official Python bindings for `Qt`_, + which enables you to use Python to write your Qt applications. + The project 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 @@ -13,8 +14,9 @@ .. ifconfig:: output_format == 'qthelp' - **Qt for Python** offers the official Python bindings for `Qt`_, and - has two main components: + **Qt for Python** offers the official Python bindings for `Qt`_, + which enables you to use Python to write your Qt applications. + The project 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 @@ -29,136 +31,184 @@ 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 +.. _`Porting from PySide2 to PySide6`: gettingstarted/porting_from2.html +Quick Start +=========== +You can obtain the latest stable version by running ``pip install pyside6``. +If you want to build it yourself, check the `getting started guide`_. + +To learn how to use it, check out `write your first application`_, +and to learn what is installed with the ``pyside6``, check the +`package content, structure, and tools`_ page. + + +.. _`getting started guide`: gettingstarted/index.html +.. _`write your first application`: quickstart.html +.. _`package content, structure, and tools`: gettingstarted/package_details.html Documentation ============= -.. ifconfig:: output_format == 'html' +.. grid:: 1 3 3 3 + :gutter: 2 - .. panels:: - :body: text-center - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + .. grid-item-card:: + :img-top: images/Desktop.svg + :class-item: text-center Write your first Qt application. + +++ + .. button-ref:: quick-start + :color: primary + :outline: + :expand: + + Start here! + .. grid-item-card:: + :img-top: images/Support.svg + :class-item: text-center + + Modules, docs, and cross compilation. +++ + .. button-ref:: gettingstarted/index + :color: primary + :outline: + :expand: - .. link-button:: quickstart - :type: ref - :text: Check it out! - :classes: btn-qt btn-block stretched-link - --- + Build Instructions - Install and build from source. + .. grid-item-card:: + :img-top: images/Commercial.svg + :class-item: text-center + Packages, installation, and details. +++ + .. button-ref:: commercial-page + :color: primary + :outline: + :expand: - .. link-button:: gettingstarted - :type: ref - :text: Getting Started - :classes: btn-qt btn-block stretched-link - --- + Commercial - PySide API reference. + .. grid-item-card:: + :img-top: images/Dev.svg + :class-item: text-center + PySide API reference. +++ + .. button-ref:: pyside-api + :color: primary + :outline: + :expand: - .. link-button:: api - :type: ref - :text: API Docs - :classes: btn-qt btn-block stretched-link + API Docs - --- + .. grid-item-card:: + :img-top: images/Tutorials.svg + :class-item: text-center Learn with step-by-step guides. - +++ + .. button-ref:: tutorials/index + :color: primary + :outline: + :expand: - .. link-button:: tutorials/index - :type: ref - :text: Tutorials - :classes: btn-qt btn-block stretched-link - --- + Tutorials - Check all the available examples. + .. grid-item-card:: + :img-top: images/Examples.svg + :class-item: text-center + Check all the available examples. +++ + .. button-ref:: examples/index + :color: primary + :outline: + :expand: - .. link-button:: examples/index - :type: ref - :text: Examples - :classes: btn-qt btn-block stretched-link - --- + Examples + + .. grid-item-card:: + :img-top: images/Training.svg + :class-item: text-center Watch webinars, talks, and more. + +++ + .. button-ref:: videos + :color: primary + :outline: + :expand: + + Videos + .. grid-item-card:: + :img-top: images/Tooling.svg + :class-item: text-center + + Discover the tools included. +++ + .. button-ref:: package_tools + :color: primary + :outline: + :expand: - .. link-button:: videos - :type: ref - :text: Videos - :classes: btn-qt btn-block stretched-link + Tooling - --- + .. grid-item-card:: + :img-top: images/Deployment.svg + :class-item: text-center Learn to deploy your applications. - +++ + .. button-ref:: deployment-guides + :color: primary + :outline: + :expand: - .. link-button:: deployment-guides - :type: ref - :text: Deployment - :classes: btn-qt btn-block stretched-link - --- + Deployment - API differences and known issues. + .. grid-item-card:: + :img-top: images/cpp_python.svg + :class-item: text-center + Generate C++ to Python bindings. +++ + .. button-link:: shiboken6/index.html + :color: primary + :outline: + :expand: - .. link-button:: considerations - :type: ref - :text: Considerations - :classes: btn-qt btn-block stretched-link - --- + Shiboken - Generate C++ to Python bindings. + .. grid-item-card:: + :img-top: images/stopwatch.svg + :class-item: text-center + API differences and known issues. +++ + .. button-ref:: considerations + :color: primary + :outline: + :expand: - .. link-button:: shiboken6/index.html - :text: Shiboken - :classes: btn-qt btn-block stretched-link + Considerations -.. ifconfig:: output_format == 'qthelp' + .. grid-item-card:: + :img-top: images/Development.svg + :class-item: text-center + + Notes for Developers. + +++ + .. button-ref:: developer-notes + :color: primary + :outline: + :expand: - .. 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> + Developers We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community. @@ -170,5 +220,3 @@ We have also a `wiki page`_ where you can find how to report bugs, contribute or :glob: contents.rst - gettingstarted* - overviews/* |