aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/tools/pyside-assistant.rst
blob: c9b3470c31d15a60f34b0b2608504669965a4d0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.. _pyside6-assistant:

pyside6-assistant
=================

``pyside6-assistant`` is a tool that wraps `Qt Assistant`_, the help
viewer of Qt for use with the Qt help file format (see `The Qt Help Framework`_).

The version of assistant shipped with Qt for Python does not contain
any documentation.

You can build the Qt for Python documentation in the Qt help file format
(see :ref:`building_documentation`) and register it for use in `Preferences`
dialog of ``pyside6-assistant`` (`Edit/Preferences`).

.. image:: pyside6-assistant_screenshot.webp
    :width: 381
    :alt: PySide6 Assistant Screenshot

.. _`Qt Assistant`: https://doc.qt.io/qt-6/qtassistant-index.html
.. _`The Qt Help Framework`: https://doc.qt.io/qt-6/qthelp-framework.html