diff options
author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-11-25 09:49:39 +0100 |
---|---|---|
committer | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-11-25 13:42:58 +0100 |
commit | 6c910046432e6562adff51fe6fe3889e116b7df9 (patch) | |
tree | 5e1e138353032c1528f69cb03d990ce8a1584329 | |
parent | 55f6d0fb5a5e859a026a0f82742ade3c44a0297c (diff) |
doc: move the FAQ out of tutorials
After feedback that the common questions are not really
tutorials, they are now moved at the end of the 'quickstart'
page, so people can understand concepts and the scope of
the project just after doing a hello-world application.
Pick-to: 6.4
Change-Id: Ib6757292ff3d30d560dd99d36a6a047653039c5d
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
-rw-r--r-- | sources/pyside6/doc/faq/distribution.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/distribution.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/hello_linux.png (renamed from sources/pyside6/doc/tutorials/pretutorial/hello_linux.png) | bin | 5960 -> 5960 bytes | |||
-rw-r--r-- | sources/pyside6/doc/faq/hello_macOS.png (renamed from sources/pyside6/doc/tutorials/pretutorial/hello_macOS.png) | bin | 38777 -> 38777 bytes | |||
-rw-r--r-- | sources/pyside6/doc/faq/hello_win10.jpg (renamed from sources/pyside6/doc/tutorials/pretutorial/hello_win10.jpg) | bin | 5314 -> 5314 bytes | |||
-rw-r--r-- | sources/pyside6/doc/faq/tiobe.png (renamed from sources/pyside6/doc/tutorials/pretutorial/tiobe.png) | bin | 49961 -> 49961 bytes | |||
-rw-r--r-- | sources/pyside6/doc/faq/typesoffiles.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/typesoffiles.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/whatisqt.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/whatisqt.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/whatisshiboken.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/whatisshiboken.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/whichide.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/whichide.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/whyqtforpython.rst (renamed from sources/pyside6/doc/tutorials/pretutorial/whyqtforpython.rst) | 0 | ||||
-rw-r--r-- | sources/pyside6/doc/quickstart.rst | 98 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/index.rst | 58 |
12 files changed, 86 insertions, 70 deletions
diff --git a/sources/pyside6/doc/tutorials/pretutorial/distribution.rst b/sources/pyside6/doc/faq/distribution.rst index fea588153..fea588153 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/distribution.rst +++ b/sources/pyside6/doc/faq/distribution.rst diff --git a/sources/pyside6/doc/tutorials/pretutorial/hello_linux.png b/sources/pyside6/doc/faq/hello_linux.png Binary files differindex f335a234d..f335a234d 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/hello_linux.png +++ b/sources/pyside6/doc/faq/hello_linux.png diff --git a/sources/pyside6/doc/tutorials/pretutorial/hello_macOS.png b/sources/pyside6/doc/faq/hello_macOS.png Binary files differindex 863149399..863149399 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/hello_macOS.png +++ b/sources/pyside6/doc/faq/hello_macOS.png diff --git a/sources/pyside6/doc/tutorials/pretutorial/hello_win10.jpg b/sources/pyside6/doc/faq/hello_win10.jpg Binary files differindex 78dcf8ab5..78dcf8ab5 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/hello_win10.jpg +++ b/sources/pyside6/doc/faq/hello_win10.jpg diff --git a/sources/pyside6/doc/tutorials/pretutorial/tiobe.png b/sources/pyside6/doc/faq/tiobe.png Binary files differindex 87647d1c2..87647d1c2 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/tiobe.png +++ b/sources/pyside6/doc/faq/tiobe.png diff --git a/sources/pyside6/doc/tutorials/pretutorial/typesoffiles.rst b/sources/pyside6/doc/faq/typesoffiles.rst index 71d38f809..71d38f809 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/typesoffiles.rst +++ b/sources/pyside6/doc/faq/typesoffiles.rst diff --git a/sources/pyside6/doc/tutorials/pretutorial/whatisqt.rst b/sources/pyside6/doc/faq/whatisqt.rst index 2dee661a7..2dee661a7 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/whatisqt.rst +++ b/sources/pyside6/doc/faq/whatisqt.rst diff --git a/sources/pyside6/doc/tutorials/pretutorial/whatisshiboken.rst b/sources/pyside6/doc/faq/whatisshiboken.rst index e867fadd4..e867fadd4 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/whatisshiboken.rst +++ b/sources/pyside6/doc/faq/whatisshiboken.rst diff --git a/sources/pyside6/doc/tutorials/pretutorial/whichide.rst b/sources/pyside6/doc/faq/whichide.rst index ec005a188..ec005a188 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/whichide.rst +++ b/sources/pyside6/doc/faq/whichide.rst diff --git a/sources/pyside6/doc/tutorials/pretutorial/whyqtforpython.rst b/sources/pyside6/doc/faq/whyqtforpython.rst index 6046249b9..6046249b9 100644 --- a/sources/pyside6/doc/tutorials/pretutorial/whyqtforpython.rst +++ b/sources/pyside6/doc/faq/whyqtforpython.rst diff --git a/sources/pyside6/doc/quickstart.rst b/sources/pyside6/doc/quickstart.rst index a65c6869a..141edf94c 100644 --- a/sources/pyside6/doc/quickstart.rst +++ b/sources/pyside6/doc/quickstart.rst @@ -3,6 +3,8 @@ Quick start =========== +New to Qt? Check also the :ref:`faq-section` section at the end of this page. + Requirements ------------ @@ -16,27 +18,39 @@ Before you can install |project|, first you must install the following software: Installation ------------ +* **Creating and activating an environment** + You can do this by running the following on a terminal: -.. raw:: html + * Create environment (Your Python executable might be called ``python3``):: - <img src="https://qt-wiki-uploads.s3.amazonaws.com/images/8/8a/Pyside6_install.gif" - style="float: right; width: 35%; padding-left: 20px;" - alt="PySide6 installation animation" /> + python -m venv env -* **Creating and activating an environment** - You can do this by running the following on a terminal: + * Activate the environment (Linux and macOS):: + + source env/bin/activate + + * Activate the environment (Windows):: - * :command:`python -m venv env`, (Your Python executable might be called ``python3``) - * :command:`source env/bin/activate` for Linux and macOS - * :command:`env\\\Scripts\\\activate.bat` for Windows + env\Scripts\activate.bat -* **Installation** + Check this animation on how to do it: + + .. image:: https://qt-wiki-uploads.s3.amazonaws.com/images/8/8a/Pyside6_install.gif + :alt: Installation gif + +* **Installing PySide6** Now you are ready to install the |project| packages using ``pip``. From the terminal, run the following command: - * :command:`pip install pyside6`, for the latest version. - * :command:`pip install pyside6==6.0`, for the version ``6.0`` specifically. + * For the latest version:: + + pip install pyside6 + + * For a specific version, like 6.4.1:: + + pip install pyside6==6.4.1 + * It is also possible to install a specific snapshot from our servers. To do so, you can use the following command:: @@ -123,3 +137,63 @@ guide you through the development process: .. image:: images/screenshot_hello.png :alt: Hello World application + +.. _faq-section: + +Frequently Asked Questions +-------------------------- + +Here you can find a couple of common questions and situations that will +clarify questions before you start programming. + +.. panels:: + :container: container-lg pb-1 + :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + + .. link-button:: faq/whatisqt + :type: ref + :text: Qt, QML, Widgets... What is the difference? + :classes: btn-link btn-block stretched-link + --- + + .. link-button:: faq/whichide + :type: ref + :text: Which IDEs are compatible with PySide? + :classes: btn-link btn-block stretched-link + --- + + .. link-button:: faq/whatisshiboken + :type: ref + :text: Binding Generation: What is Shiboken? + :classes: btn-link btn-block stretched-link + --- + + .. link-button:: faq/typesoffiles + :type: ref + :text: File Types in PySide + :classes: btn-link btn-block stretched-link + --- + + .. link-button:: faq/distribution + :type: ref + :text: Distributing your application to other systems and platforms + :classes: btn-link btn-block stretched-link + + --- + + .. link-button:: faq/whyqtforpython + :type: ref + :text: As a Qt/C++ developer, why should I consider Qt for Python? + :classes: btn-link btn-block stretched-link + +.. toctree:: + :hidden: + + faq/whatisqt.rst + faq/whichide.rst + faq/whatisshiboken.rst + faq/typesoffiles.rst + faq/distribution.rst + faq/whyqtforpython.rst + + diff --git a/sources/pyside6/doc/tutorials/index.rst b/sources/pyside6/doc/tutorials/index.rst index 653bc19ab..3c835cf5a 100644 --- a/sources/pyside6/doc/tutorials/index.rst +++ b/sources/pyside6/doc/tutorials/index.rst @@ -8,64 +8,6 @@ Some of these documents were ported from C++ to Python and cover a range of topics, from basic use of widgets to step-by-step tutorials that show how an application is put together. -Before you start ----------------- - -Here you can find a couple of common questions and situations that will -clarify questions before you start programming. -If you have not installed PySide yet, remember to check the -`Quick Start <../quickstart.html>`_ section. - -.. panels:: - :container: container-lg pb-1 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 - - .. link-button:: pretutorial/whatisqt - :type: ref - :text: Qt, QML, Widgets... What is the difference? - :classes: btn-link btn-block stretched-link - --- - - .. link-button:: pretutorial/whichide - :type: ref - :text: Which IDEs are compatible with PySide? - :classes: btn-link btn-block stretched-link - --- - - .. link-button:: pretutorial/whatisshiboken - :type: ref - :text: Binding Generation: What is Shiboken? - :classes: btn-link btn-block stretched-link - --- - - .. link-button:: pretutorial/typesoffiles - :type: ref - :text: File Types in PySide - :classes: btn-link btn-block stretched-link - --- - - .. link-button:: pretutorial/distribution - :type: ref - :text: Distributing your application to other systems and platforms - :classes: btn-link btn-block stretched-link - - --- - - .. link-button:: pretutorial/whyqtforpython - :type: ref - :text: As a Qt/C++ developer, why should I consider Qt for Python? - :classes: btn-link btn-block stretched-link - -.. toctree:: - :hidden: - - pretutorial/whatisqt.rst - pretutorial/whichide.rst - pretutorial/whatisshiboken.rst - pretutorial/typesoffiles.rst - pretutorial/distribution.rst - pretutorial/whyqtforpython.rst - Qt Widgets: Basic tutorials --------------------------- |