aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-06-10 20:46:25 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2021-06-12 19:31:17 +0000
commit090d4fba6a444590d850c697472e5fbcef46b0a4 (patch)
treecd2c70bfdf6549d962daaf266f4f2223cd4cc9a9
parent32222315eb32177d4161ee2e417d9910a07f6039 (diff)
examples: add screenshots to more modules
Adding screenshots and small documentation file to the modules - corelib - datavisualization - external - opengl - quick - sql - uitools - webchannel - webenginewidgets - some widgets - xml Renaming the widgets gallery due to name conflict with the quick controls gallery, and fixing two typos from contextinfo.py and hellogl2.py. Task-number: PYSIDE-841 Pick-to: 6.1 Change-Id: I2705e5d605fa738da0dca906cf6acb4b9d5d3dcd Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
-rw-r--r--examples/corelib/settingseditor/doc/settingseditor.pngbin0 -> 10234 bytes
-rw-r--r--examples/corelib/settingseditor/doc/settingseditor.rst10
-rw-r--r--examples/corelib/threads/doc/threads.pngbin0 -> 61689 bytes
-rw-r--r--examples/corelib/threads/doc/threads.rst10
-rw-r--r--examples/datavisualization/bars3d/doc/bars3d.pngbin0 -> 31558 bytes
-rw-r--r--examples/datavisualization/bars3d/doc/bars3d.rst8
-rw-r--r--examples/designer/taskmenuextension/doc/taskmenuextension.pngbin0 -> 142848 bytes
-rw-r--r--examples/designer/taskmenuextension/doc/taskmenuextension.rst15
-rw-r--r--examples/external/matplotlib/widget3d/doc/widget3d.pngbin0 -> 135383 bytes
-rw-r--r--examples/external/matplotlib/widget3d/doc/widget3d.rst9
-rw-r--r--examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.pngbin0 -> 16198 bytes
-rw-r--r--examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.rst9
-rw-r--r--examples/external/opencv/doc/opencv.pngbin0 -> 132069 bytes
-rw-r--r--examples/external/opencv/doc/opencv.rst9
-rw-r--r--examples/external/opencv/opencv.pyproject3
-rw-r--r--examples/external/pandas/doc/pandas.rst9
-rw-r--r--examples/external/pandas/doc/pandas_simple.pngbin0 -> 37161 bytes
-rw-r--r--examples/external/scikit/doc/scikit.pngbin0 -> 390406 bytes
-rw-r--r--examples/external/scikit/doc/scikit.rst9
-rw-r--r--examples/external/scikit/scikit.pyproject3
-rw-r--r--examples/opengl/contextinfo/contextinfo.py12
-rw-r--r--examples/opengl/contextinfo/doc/contextinfo.pngbin0 -> 35022 bytes
-rw-r--r--examples/opengl/contextinfo/doc/contextinfo.rst10
-rw-r--r--examples/opengl/hellogl2/doc/hellogl2.pngbin0 -> 4143 bytes
-rw-r--r--examples/opengl/hellogl2/doc/hellogl2.rst9
-rw-r--r--examples/opengl/hellogl2/hellogl2.py2
-rw-r--r--examples/opengl/textures/doc/textures.pngbin0 -> 38108 bytes
-rw-r--r--examples/opengl/textures/doc/textures.rst9
-rw-r--r--examples/quick/painteditem/doc/painteditem.pngbin0 -> 3768 bytes
-rw-r--r--examples/quick/painteditem/doc/painteditem.rst11
-rw-r--r--examples/quickcontrols2/gallery/doc/gallery.pngbin0 -> 23828 bytes
-rw-r--r--examples/sql/books/doc/books.pngbin0 -> 59045 bytes
-rw-r--r--examples/sql/books/doc/books.rst11
-rw-r--r--examples/webchannel/standalone/doc/standalone.pngbin0 -> 47586 bytes
-rw-r--r--examples/webchannel/standalone/doc/standalone.rst8
-rw-r--r--examples/webenginequick/nanobrowser/doc/nanobrowser.pngbin0 -> 56339 bytes
-rw-r--r--examples/webenginequick/nanobrowser/doc/nanobrowser.rst8
-rw-r--r--examples/webenginewidgets/simplebrowser/doc/simplebrowser.pngbin0 -> 51615 bytes
-rw-r--r--examples/webenginewidgets/simplebrowser/doc/simplebrowser.rst8
-rw-r--r--examples/widgets/widgetsgallery/doc/widgetsgallery.pngbin0 -> 49870 bytes
-rw-r--r--examples/widgets/widgetsgallery/doc/widgetsgallery.rst16
-rw-r--r--examples/widgets/widgetsgallery/main.py (renamed from examples/widgets/gallery/main.py)0
-rw-r--r--examples/widgets/widgetsgallery/widgetgallery.py (renamed from examples/widgets/gallery/widgetgallery.py)0
-rw-r--r--examples/widgets/widgetsgallery/widgetsgallery.pyproject (renamed from examples/widgets/gallery/gallery.pyproject)0
-rw-r--r--examples/xml/dombookmarks/doc/dombookmarks.pngbin0 -> 35779 bytes
-rw-r--r--examples/xml/dombookmarks/doc/dombookmarks.rst12
46 files changed, 203 insertions, 7 deletions
diff --git a/examples/corelib/settingseditor/doc/settingseditor.png b/examples/corelib/settingseditor/doc/settingseditor.png
new file mode 100644
index 000000000..d281125d3
--- /dev/null
+++ b/examples/corelib/settingseditor/doc/settingseditor.png
Binary files differ
diff --git a/examples/corelib/settingseditor/doc/settingseditor.rst b/examples/corelib/settingseditor/doc/settingseditor.rst
new file mode 100644
index 000000000..4c60dbe8e
--- /dev/null
+++ b/examples/corelib/settingseditor/doc/settingseditor.rst
@@ -0,0 +1,10 @@
+Settings Editor Example
+=======================
+
+The Settings Editor example shows how Qt's standard settings support is used in
+an application by providing an editor that enables the user to view the
+settings for installed applications, and modify those that can be edited.
+
+.. image:: settingseditor.png
+ :width: 400
+ :alt: Settings Editor Screenshot
diff --git a/examples/corelib/threads/doc/threads.png b/examples/corelib/threads/doc/threads.png
new file mode 100644
index 000000000..d022f4aff
--- /dev/null
+++ b/examples/corelib/threads/doc/threads.png
Binary files differ
diff --git a/examples/corelib/threads/doc/threads.rst b/examples/corelib/threads/doc/threads.rst
new file mode 100644
index 000000000..d1bcf6fd4
--- /dev/null
+++ b/examples/corelib/threads/doc/threads.rst
@@ -0,0 +1,10 @@
+Mandelbrot Threads Example
+==========================
+
+The Mandelbrot example demonstrates multi-thread programming using Qt. It shows
+how to use a worker thread to perform heavy computations without blocking the
+main thread's event loop.
+
+.. image:: threads.png
+ :width: 400
+ :alt: Mandelbrot Threads Screenshot
diff --git a/examples/datavisualization/bars3d/doc/bars3d.png b/examples/datavisualization/bars3d/doc/bars3d.png
new file mode 100644
index 000000000..fc5cdc168
--- /dev/null
+++ b/examples/datavisualization/bars3d/doc/bars3d.png
Binary files differ
diff --git a/examples/datavisualization/bars3d/doc/bars3d.rst b/examples/datavisualization/bars3d/doc/bars3d.rst
new file mode 100644
index 000000000..aaa7ea158
--- /dev/null
+++ b/examples/datavisualization/bars3d/doc/bars3d.rst
@@ -0,0 +1,8 @@
+Bars 3D Example
+===============
+
+The bars example shows how to make a 3D bar graph using Q3DBars.
+
+.. image:: simple3d.png
+ :width: 400
+ :alt: Bards 3D Screenshot
diff --git a/examples/designer/taskmenuextension/doc/taskmenuextension.png b/examples/designer/taskmenuextension/doc/taskmenuextension.png
new file mode 100644
index 000000000..a1fe22e05
--- /dev/null
+++ b/examples/designer/taskmenuextension/doc/taskmenuextension.png
Binary files differ
diff --git a/examples/designer/taskmenuextension/doc/taskmenuextension.rst b/examples/designer/taskmenuextension/doc/taskmenuextension.rst
new file mode 100644
index 000000000..a1b584fb9
--- /dev/null
+++ b/examples/designer/taskmenuextension/doc/taskmenuextension.rst
@@ -0,0 +1,15 @@
+Task Menu Extension (Designer)
+==============================
+
+This example shows how to add custom widgets to Qt Designer,
+which can be launched with `pyside6-designer`, and to extend
+its built-in context menu.
+
+The main mechanism is based on the :ref:`QPyDesignerCustomWidgetCollection`
+class that takes care of handling the registration.
+
+More information can be found in :ref:`designer_custom_widgets`.
+
+.. image:: taskmenuextension.png
+ :width: 400
+ :alt: Task Menu Extension Screenshot
diff --git a/examples/external/matplotlib/widget3d/doc/widget3d.png b/examples/external/matplotlib/widget3d/doc/widget3d.png
new file mode 100644
index 000000000..fa2ed5043
--- /dev/null
+++ b/examples/external/matplotlib/widget3d/doc/widget3d.png
Binary files differ
diff --git a/examples/external/matplotlib/widget3d/doc/widget3d.rst b/examples/external/matplotlib/widget3d/doc/widget3d.rst
new file mode 100644
index 000000000..b5c9fd8fd
--- /dev/null
+++ b/examples/external/matplotlib/widget3d/doc/widget3d.rst
@@ -0,0 +1,9 @@
+Matplotlib Widget 3D Example
+============================
+
+A Python application that demonstrates how to combine matplotlib
+with Qt Widget-based functionality.
+
+.. image:: widget3d.png
+ :width: 400
+ :alt: Matplotlib Widget 3D Screenshot
diff --git a/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.png b/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.png
new file mode 100644
index 000000000..e9fe16354
--- /dev/null
+++ b/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.png
Binary files differ
diff --git a/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.rst b/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.rst
new file mode 100644
index 000000000..467fb42c2
--- /dev/null
+++ b/examples/external/matplotlib/widget_gaussian/doc/widget_gaussian.rst
@@ -0,0 +1,9 @@
+Matplotlib Widget Gaussian Example
+==================================
+
+A Python application that demonstrates how to interact with
+matplotlib and scipy, combined with Qt Widgets.
+
+.. image:: widget_gaussian.png
+ :width: 400
+ :alt: Matplotlib Widget Gaussian Screenshot
diff --git a/examples/external/opencv/doc/opencv.png b/examples/external/opencv/doc/opencv.png
new file mode 100644
index 000000000..e3edcab47
--- /dev/null
+++ b/examples/external/opencv/doc/opencv.png
Binary files differ
diff --git a/examples/external/opencv/doc/opencv.rst b/examples/external/opencv/doc/opencv.rst
new file mode 100644
index 000000000..ff2c72501
--- /dev/null
+++ b/examples/external/opencv/doc/opencv.rst
@@ -0,0 +1,9 @@
+OpenCV Face Detection Example
+=============================
+
+A Python application that demonstrates how to use OpenCV
+and a trained model to detect faces detected from a webcam.
+
+.. image:: opencv.png
+ :width: 400
+ :alt: OpenCV Face Detection Screenshot
diff --git a/examples/external/opencv/opencv.pyproject b/examples/external/opencv/opencv.pyproject
new file mode 100644
index 000000000..dd9a73e24
--- /dev/null
+++ b/examples/external/opencv/opencv.pyproject
@@ -0,0 +1,3 @@
+{
+ "files": ["webcam_pattern_detection.py"]
+}
diff --git a/examples/external/pandas/doc/pandas.rst b/examples/external/pandas/doc/pandas.rst
new file mode 100644
index 000000000..8e75eead4
--- /dev/null
+++ b/examples/external/pandas/doc/pandas.rst
@@ -0,0 +1,9 @@
+Pandas Simple Example
+=====================
+
+A Python application that demonstrates how to visualize
+a Pandas DataFrame.
+
+.. image:: pandas_simple.png
+ :width: 400
+ :alt: Pandas Simple Screenshot
diff --git a/examples/external/pandas/doc/pandas_simple.png b/examples/external/pandas/doc/pandas_simple.png
new file mode 100644
index 000000000..ea5d240bd
--- /dev/null
+++ b/examples/external/pandas/doc/pandas_simple.png
Binary files differ
diff --git a/examples/external/scikit/doc/scikit.png b/examples/external/scikit/doc/scikit.png
new file mode 100644
index 000000000..930a1c7c9
--- /dev/null
+++ b/examples/external/scikit/doc/scikit.png
Binary files differ
diff --git a/examples/external/scikit/doc/scikit.rst b/examples/external/scikit/doc/scikit.rst
new file mode 100644
index 000000000..29ebbddbf
--- /dev/null
+++ b/examples/external/scikit/doc/scikit.rst
@@ -0,0 +1,9 @@
+Scikit Image Example
+====================
+
+A Python application that demonstrates how to use Scikit Image
+to apply filters to images based on a Qt Widgets.
+
+.. image:: scikit.png
+ :width: 400
+ :alt: Scikit Image Screenshot
diff --git a/examples/external/scikit/scikit.pyproject b/examples/external/scikit/scikit.pyproject
new file mode 100644
index 000000000..5026c86e3
--- /dev/null
+++ b/examples/external/scikit/scikit.pyproject
@@ -0,0 +1,3 @@
+{
+ "files": ["staining_colors_separation.py"]
+}
diff --git a/examples/opengl/contextinfo/contextinfo.py b/examples/opengl/contextinfo/contextinfo.py
index 47fd83abc..73b55df13 100644
--- a/examples/opengl/contextinfo/contextinfo.py
+++ b/examples/opengl/contextinfo/contextinfo.py
@@ -245,12 +245,12 @@ class RenderWindow(QWindow):
context_surface_format = print_surface_format(self.context.format())
surface_format = print_surface_format(self.format())
- text = ("Vendor: {gl_vendor}\n"
- "Renderer: {gl_renderer}\n"
- "Version: {gl_version}\n"
- "Shading language: {gl_lang_version}\n"
- "Context Format: {context_surface_format}\n\n"
- "Surface Format: {surface_format}")
+ text = (f"Vendor: {gl_vendor}\n"
+ f"Renderer: {gl_renderer}\n"
+ f"Version: {gl_version}\n"
+ f"Shading language: {gl_lang_version}\n"
+ f"Context Format: {context_surface_format}\n\n"
+ f"Surface Format: {surface_format}")
self.context.doneCurrent()
return text
diff --git a/examples/opengl/contextinfo/doc/contextinfo.png b/examples/opengl/contextinfo/doc/contextinfo.png
new file mode 100644
index 000000000..c7911f162
--- /dev/null
+++ b/examples/opengl/contextinfo/doc/contextinfo.png
Binary files differ
diff --git a/examples/opengl/contextinfo/doc/contextinfo.rst b/examples/opengl/contextinfo/doc/contextinfo.rst
new file mode 100644
index 000000000..1fa9eb42d
--- /dev/null
+++ b/examples/opengl/contextinfo/doc/contextinfo.rst
@@ -0,0 +1,10 @@
+Context Info Example
+====================
+
+The example shows the information about the OpenGL-related graphics
+configuration of the current system. This can be useful as a
+diagnostic tool.
+
+.. image:: contextinfo.png
+ :width: 400
+ :alt: Context Simple Screenshot
diff --git a/examples/opengl/hellogl2/doc/hellogl2.png b/examples/opengl/hellogl2/doc/hellogl2.png
new file mode 100644
index 000000000..674ea9fbe
--- /dev/null
+++ b/examples/opengl/hellogl2/doc/hellogl2.png
Binary files differ
diff --git a/examples/opengl/hellogl2/doc/hellogl2.rst b/examples/opengl/hellogl2/doc/hellogl2.rst
new file mode 100644
index 000000000..1223e138c
--- /dev/null
+++ b/examples/opengl/hellogl2/doc/hellogl2.rst
@@ -0,0 +1,9 @@
+Hello GL2 Example
+=================
+
+The Hello GL2 example demonstrates the basic use of the OpenGL-related classes
+provided with Qt.
+
+.. image:: hellogl2.png
+ :width: 400
+ :alt: Hello GL2 Screenshot
diff --git a/examples/opengl/hellogl2/hellogl2.py b/examples/opengl/hellogl2/hellogl2.py
index 6dfc032ad..2f170dc90 100644
--- a/examples/opengl/hellogl2/hellogl2.py
+++ b/examples/opengl/hellogl2/hellogl2.py
@@ -232,7 +232,7 @@ class GLWidget(QOpenGLWidget, QOpenGLFunctions):
def __init__(self, transparent, parent=None):
QOpenGLWidget.__init__(self, parent)
- super().__init__()
+ QOpenGLFunctions.__init__(self)
self._transparent = transparent
self._core = QSurfaceFormat.defaultFormat().profile() == QSurfaceFormat.CoreProfile
diff --git a/examples/opengl/textures/doc/textures.png b/examples/opengl/textures/doc/textures.png
new file mode 100644
index 000000000..ff80a7d8f
--- /dev/null
+++ b/examples/opengl/textures/doc/textures.png
Binary files differ
diff --git a/examples/opengl/textures/doc/textures.rst b/examples/opengl/textures/doc/textures.rst
new file mode 100644
index 000000000..80bf20451
--- /dev/null
+++ b/examples/opengl/textures/doc/textures.rst
@@ -0,0 +1,9 @@
+Texture Example
+===============
+
+The Textures example demonstrates the use of Qt's image classes as textures in
+applications that use both OpenGL and Qt to display graphics.
+
+.. image:: textures.png
+ :width: 400
+ :alt: Textures Screenshot
diff --git a/examples/quick/painteditem/doc/painteditem.png b/examples/quick/painteditem/doc/painteditem.png
new file mode 100644
index 000000000..743cd11b5
--- /dev/null
+++ b/examples/quick/painteditem/doc/painteditem.png
Binary files differ
diff --git a/examples/quick/painteditem/doc/painteditem.rst b/examples/quick/painteditem/doc/painteditem.rst
new file mode 100644
index 000000000..6f12355ca
--- /dev/null
+++ b/examples/quick/painteditem/doc/painteditem.rst
@@ -0,0 +1,11 @@
+Scene Graph Painted Item Example
+================================
+
+Shows how to implement QPainter-based custom scenegraph items.
+
+The Painted Item example shows how to use the QML Scene Graph framework to
+implement custom scenegraph items using QPainter.
+
+.. image:: painteditem.png
+ :width: 400
+ :alt: Painted Item Screenshot
diff --git a/examples/quickcontrols2/gallery/doc/gallery.png b/examples/quickcontrols2/gallery/doc/gallery.png
new file mode 100644
index 000000000..615ea9e3c
--- /dev/null
+++ b/examples/quickcontrols2/gallery/doc/gallery.png
Binary files differ
diff --git a/examples/sql/books/doc/books.png b/examples/sql/books/doc/books.png
new file mode 100644
index 000000000..102395155
--- /dev/null
+++ b/examples/sql/books/doc/books.png
Binary files differ
diff --git a/examples/sql/books/doc/books.rst b/examples/sql/books/doc/books.rst
new file mode 100644
index 000000000..cb8edc2ac
--- /dev/null
+++ b/examples/sql/books/doc/books.rst
@@ -0,0 +1,11 @@
+SQL Books Example
+=================
+
+Shows how to use Qt SQL classes with a model/view framework.
+
+The Books example shows how Qt's SQL classes can be used with the model/view
+framework to create rich user interfaces for information stored in a database.
+
+.. image:: books.png
+ :width: 400
+ :alt: SQL Books Screenshot
diff --git a/examples/webchannel/standalone/doc/standalone.png b/examples/webchannel/standalone/doc/standalone.png
new file mode 100644
index 000000000..972b0fbbf
--- /dev/null
+++ b/examples/webchannel/standalone/doc/standalone.png
Binary files differ
diff --git a/examples/webchannel/standalone/doc/standalone.rst b/examples/webchannel/standalone/doc/standalone.rst
new file mode 100644
index 000000000..f22f32c23
--- /dev/null
+++ b/examples/webchannel/standalone/doc/standalone.rst
@@ -0,0 +1,8 @@
+WebChannel Standalone Example
+=============================
+
+A simple chat between a server and a remote client running in a browser.
+
+.. image:: standalone.png
+ :width: 400
+ :alt: WebChannel Standalone Screenshot
diff --git a/examples/webenginequick/nanobrowser/doc/nanobrowser.png b/examples/webenginequick/nanobrowser/doc/nanobrowser.png
new file mode 100644
index 000000000..3dddb05d9
--- /dev/null
+++ b/examples/webenginequick/nanobrowser/doc/nanobrowser.png
Binary files differ
diff --git a/examples/webenginequick/nanobrowser/doc/nanobrowser.rst b/examples/webenginequick/nanobrowser/doc/nanobrowser.rst
new file mode 100644
index 000000000..850985072
--- /dev/null
+++ b/examples/webenginequick/nanobrowser/doc/nanobrowser.rst
@@ -0,0 +1,8 @@
+Nano Browser Example
+====================
+
+A web browser implemented using the WebEngineView QML type.
+
+.. image:: nanobrowser.png
+ :width: 400
+ :alt: Nano Browser Screenshot
diff --git a/examples/webenginewidgets/simplebrowser/doc/simplebrowser.png b/examples/webenginewidgets/simplebrowser/doc/simplebrowser.png
new file mode 100644
index 000000000..3fa5a0046
--- /dev/null
+++ b/examples/webenginewidgets/simplebrowser/doc/simplebrowser.png
Binary files differ
diff --git a/examples/webenginewidgets/simplebrowser/doc/simplebrowser.rst b/examples/webenginewidgets/simplebrowser/doc/simplebrowser.rst
new file mode 100644
index 000000000..83dd109c5
--- /dev/null
+++ b/examples/webenginewidgets/simplebrowser/doc/simplebrowser.rst
@@ -0,0 +1,8 @@
+Simple Browser Example
+======================
+
+A simple browser based on Qt WebEngine Widgets.
+
+.. image:: simplebrowser.png
+ :width: 400
+ :alt: Simple Browser Screenshot
diff --git a/examples/widgets/widgetsgallery/doc/widgetsgallery.png b/examples/widgets/widgetsgallery/doc/widgetsgallery.png
new file mode 100644
index 000000000..236296681
--- /dev/null
+++ b/examples/widgets/widgetsgallery/doc/widgetsgallery.png
Binary files differ
diff --git a/examples/widgets/widgetsgallery/doc/widgetsgallery.rst b/examples/widgets/widgetsgallery/doc/widgetsgallery.rst
new file mode 100644
index 000000000..336eb7e46
--- /dev/null
+++ b/examples/widgets/widgetsgallery/doc/widgetsgallery.rst
@@ -0,0 +1,16 @@
+Widgets Gallery Example
+=======================
+
+Qt's support for widget styles and themes enables your application to fit in
+with the native desktop environment.
+
+The widgets examples show how some of the widgets available in Qt might appear
+when configured to use the a particular style. Each style is only available on
+the respective platfom, and provides native look and feel by integrating to the
+platform theme. Thus, the final appearance varies depending on the active
+theme.
+
+
+.. image:: widgetsgallery.png
+ :width: 400
+ :alt: Widgets Gallery Screenshot
diff --git a/examples/widgets/gallery/main.py b/examples/widgets/widgetsgallery/main.py
index c3602321b..c3602321b 100644
--- a/examples/widgets/gallery/main.py
+++ b/examples/widgets/widgetsgallery/main.py
diff --git a/examples/widgets/gallery/widgetgallery.py b/examples/widgets/widgetsgallery/widgetgallery.py
index f57e23992..f57e23992 100644
--- a/examples/widgets/gallery/widgetgallery.py
+++ b/examples/widgets/widgetsgallery/widgetgallery.py
diff --git a/examples/widgets/gallery/gallery.pyproject b/examples/widgets/widgetsgallery/widgetsgallery.pyproject
index 635e123b0..635e123b0 100644
--- a/examples/widgets/gallery/gallery.pyproject
+++ b/examples/widgets/widgetsgallery/widgetsgallery.pyproject
diff --git a/examples/xml/dombookmarks/doc/dombookmarks.png b/examples/xml/dombookmarks/doc/dombookmarks.png
new file mode 100644
index 000000000..6a500238a
--- /dev/null
+++ b/examples/xml/dombookmarks/doc/dombookmarks.png
Binary files differ
diff --git a/examples/xml/dombookmarks/doc/dombookmarks.rst b/examples/xml/dombookmarks/doc/dombookmarks.rst
new file mode 100644
index 000000000..558cd0fbb
--- /dev/null
+++ b/examples/xml/dombookmarks/doc/dombookmarks.rst
@@ -0,0 +1,12 @@
+DOM Bookmarks Example
+=====================
+
+Provides a reader for XML Bookmark Exchange Language files.
+
+The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language
+(XBEL) files that uses Qt's DOM-based XML API to read and parse the files. The
+SAX Bookmarks example provides an alternative way to read this type of file.
+
+.. image:: dombookmarks.png
+ :width: 400
+ :alt: DOM Bookmark Screenshot