diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2021-06-17 15:28:26 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2021-06-17 17:48:09 +0200 |
| commit | 06d0883fb4758525f198cf848a45a31026ecb56f (patch) | |
| tree | 53dd6c4e58f478d2f7c4bf34142ada256f5ac283 | |
| parent | 1fcc2323b7e85ba7f71e81a97eb36567f74b37a9 (diff) | |
PySide6: Add some information on the tools
Task-number: PYSIDE-1378
Change-Id: I9433fd3b1d4d09c6a7d961d67c103ccd651e5beb
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/pyside6/doc/considerations.rst | 19 | ||||
| -rw-r--r-- | sources/pyside6/doc/gettingstarted.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst | 2 | ||||
| -rw-r--r-- | sources/pyside6/doc/tutorials/basictutorial/uifiles.rst | 2 |
4 files changed, 25 insertions, 0 deletions
diff --git a/sources/pyside6/doc/considerations.rst b/sources/pyside6/doc/considerations.rst index b52b43aa0..08e53e329 100644 --- a/sources/pyside6/doc/considerations.rst +++ b/sources/pyside6/doc/considerations.rst @@ -203,3 +203,22 @@ More about features ------------------- Detailed info about features can be found here: :ref:`feature-why` + +Tools +----- + +|project| ships some Qt tools: + +* ``pyside6-rcc``: Qt Resource Compiler. This is a command line tool + that compiles ``.qrc`` files containing binary data, for example images, + into executable Python code (see :ref:`using_qrc_files`). +* ``pyside6-uic``: Qt User Interface Compiler. This is a command line tool + that compiles ``.ui`` files containing designs of Qt Widget-based forms + into executable Python code (see :ref:`using_ui_files`). +* ``pyside6-assistant``: Qt Help Viewer. This is a graphical tool that can + be used to view Qt documentation from Qt Compressed Help files (``.qhc``). + Currently, only the binary without documentation sets is shipped to reduce the + wheel size. For building the documentation, see :ref:`building_documentation`. +* ``pyside6-designer``: Qt User Interface Designer. This is a graphical tool + to create designs of Qt Widget-based forms and use custom widgets + (see :ref:`using_ui_files`, :ref:`designer_custom_widgets`). diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst index e5731c4d3..58a5d646b 100644 --- a/sources/pyside6/doc/gettingstarted.rst +++ b/sources/pyside6/doc/gettingstarted.rst @@ -99,6 +99,8 @@ You can also run a specific test (for example ``qpainter_test``) by running:: ctest -R qpainter_test --verbose +.. _building_documentation: + Building the documentation -------------------------- diff --git a/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst b/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst index 5ac560a8f..001066ba6 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/qrcfiles.rst @@ -1,3 +1,5 @@ +.. _using_qrc_files: + Using `.qrc` Files (`pyside6-rcc`) ********************************** diff --git a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst index 579fc5ebb..32ebf7b20 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst @@ -1,3 +1,5 @@ +.. _using_ui_files: + Using `.ui` files from Designer or QtCreator with `QUiLoader` and `pyside6-uic` ******************************************************************************* |