From a86c08345730bae70f32cfc9ff2f298a2e8cbfad Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Tue, 19 Mar 2024 09:59:55 +0100 Subject: doc: add page for pyside6-qmlcachegen Change-Id: Ieac855ed8bf776759ee314ea99d25613eef03d2c Reviewed-by: Cristian Maureira-Fredes --- sources/pyside6/doc/tools/pyside-qmlcachegen.rst | 25 ++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 sources/pyside6/doc/tools/pyside-qmlcachegen.rst diff --git a/sources/pyside6/doc/tools/pyside-qmlcachegen.rst b/sources/pyside6/doc/tools/pyside-qmlcachegen.rst new file mode 100644 index 000000000..ecd8e6afd --- /dev/null +++ b/sources/pyside6/doc/tools/pyside-qmlcachegen.rst @@ -0,0 +1,25 @@ +.. _pyside6-qmlcachegen: + +pyside6-qmlcachegen +=================== + +``pyside6-qmlcachegen`` is a command line tool that wraps `qmlcachegen`_. +This tool creates C++ code or `QML byte code` for ``.qml`` files. For +Qt for Python, only `QML byte code` is relevant. The file suffix is +``.qmlc`` and it works similar to compiled Python bytecode +(``.pyc`` files). + +Usage +----- + +The command line option ``--only-bytecode`` should be used to +create `QML byte code`. For example: + +.. code-block:: bash + + qmlcachegen --only-bytecode gallery.qml + +produces a file ``gallery.qmlc`` containing `QML byte code` which is +automatically loaded by the QML engine. + +.. _`qmlcachegen`: https://doc.qt.io/qt-6/qtqml-tool-qmlcachegen.html -- cgit v1.2.3