diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-11-21 08:22:30 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2025-11-25 11:48:26 +0100 |
| commit | 42ba32dcfd1db0f1ddd2235da069f56a9632f269 (patch) | |
| tree | 22c3cab907fc9ddd2f2c529bcdcbe6974d48136d | |
| parent | 8e969657c834e600fbabad9f4e85c768ddd361de (diff) | |
Update documentation on porting examples
List useful environment variables and remove the snake case point
since it causes maintenance problems.
Pick-to: 6.10
Change-Id: I5c3d5e182b471ab3983e3a124ad95389d0d9bc7f
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/pyside6/doc/developer/add_port_example.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/sources/pyside6/doc/developer/add_port_example.rst b/sources/pyside6/doc/developer/add_port_example.rst index 909986e79..e65c3c9c8 100644 --- a/sources/pyside6/doc/developer/add_port_example.rst +++ b/sources/pyside6/doc/developer/add_port_example.rst @@ -67,11 +67,17 @@ Port a Qt example - Note that our examples need to have unique names due to the doc build. - Verify that all slots are decorated using ``@Slot``. - Enumerations should be fully qualified (PYSIDE-1735). +- Check the above by running the example with the environment variables: + + .. code-block:: bash + + export PYSIDE6_OPTION_PYTHON_ENUM=0x71 + export QT_LOGGING_RULES=qt.pyside.libpyside.warning=true + - Add a ``.pyproject`` file (verify later on that docs build). -- Add a ``doc`` directory and descriptive ``.rst`` file, +- Add a ``doc`` directory and descriptive ``.md`` or ``.rst`` file, and a screenshot if suitable (use ``optipng`` to reduce file size). - Add the ``"""Port of the ... example from Qt 6"""`` doc string. -- Try to port variable and function names to snake case convention. - Remove C++ documentation from ``sources/pyside6/doc/additionaldocs.lst``. .. note:: Example screenshots in ``.png`` should be optimized by |