1 files changed, 33 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.QmlSingleton.rst b/sources/pyside6/doc/extras/QtQml.QmlSingleton.rst
new file mode 100644
index 000000000..402c18d55
--- /dev/null
+++ b/sources/pyside6/doc/extras/QtQml.QmlSingleton.rst
@@ -0,0 +1,33 @@
+.. currentmodule:: PySide6.QtQml
+.. py:decorator:: QmlSingleton
+
+Declares the decorated type to be a singleton in QML. This only takes effect if
+the type is a QObject and is available in QML (by having a QmlElement decorator).
+The QQmlEngine will try to create a singleton instance using the type's default
+constructor.
+
+.. code-block:: python
+
+    QML_IMPORT_NAME = "com.library.name"
+    QML_IMPORT_MAJOR_VERSION = 1
+    QML_IMPORT_MINOR_VERSION = 0 # Optional
+
+    @QmlElement
+    @QmlSingleton
+    class ClassForQml(QObject):
+        ...
+
+It is also possible to use a static ``create()`` method which receives
+the engine as a parameter:
+
+.. code-block:: python
+
+    @QmlElement
+    @QmlSingleton
+    class ClassForQml(QObject):
+
+        @staticmethod
+        def create(engine):
+            ...
+
+.. note:: The order of the decorators matters; ``QmlSingleton`` needs to be preceded by ``QmlElement``.