Merge pull request #4036 from t20100/fix-doc

Updated and fixed documentation

MANIFEST.in

@@ -11,7 +11,7 @@ include requirements-dev.txt
 include pyproject.toml
 recursive-include src/silx *.pyx *.pxd *.pxi
 recursive-include src/silx *.h *.c *.hpp *.cpp
-recursive-include doc/source *.py *.rst *.png *.ico *.ipynb
+recursive-include doc/source *.py *.rst *.png *.ico *.ipynb *.html *.svg
 global-exclude .ipynb_checkpoints/*
 recursive-include qtdesigner_plugins *.py *.rst
 recursive-include src/silx/resources *

doc/source/modules/gui/icons.rst

@@ -317,6 +317,8 @@ Available icons
      - rotate-3d
    * - |rudder|
      - rudder
+   * - |ruler|
+     - ruler
    * - |scale-auto|
      - scale-auto
    * - |scale-fixed|
@@ -561,6 +563,7 @@ Available icons
 .. |rm| image:: ../../../../src/silx/resources/gui/icons/rm.png
 .. |rotate-3d| image:: ../../../../src/silx/resources/gui/icons/rotate-3d.png
 .. |rudder| image:: ../../../../src/silx/resources/gui/icons/rudder.png
+.. |ruler| image:: ../../../../src/silx/resources/gui/icons/ruler.png
 .. |scale-auto| image:: ../../../../src/silx/resources/gui/icons/scale-auto.png
 .. |scale-fixed| image:: ../../../../src/silx/resources/gui/icons/scale-fixed.png
 .. |selected| image:: ../../../../src/silx/resources/gui/icons/selected.png

doc/source/sample_code/index.rst

@@ -365,10 +365,6 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot
          :width: 150px
      - This script is an example to illustrate how to use axis synchronization
        tool.
-   * - :download:`compositeline.py <../../../examples/compositeline.py>`
-     - .. image:: img/compositeline.png
-         :width: 150px
-     - Example to show the use of markers to draw head and tail of lines.
    * - :download:`dropZones.py <../../../examples/dropZones.py>`
      - .. image:: img/dropZones.png
          :width: 150px
@@ -386,6 +382,10 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot
          :width: 150px
      - This script is an example to illustrate how to use axis synchronization
        tool.
+   * - :download:`compareBackends.py <../../../examples/compareBackends.py>`
+     - .. image:: img/compareBackends.png
+         :width: 150px
+     - This script compares the rendering of PlotWidget's matplotlib and OpenGL backends.
 
 
 .. _plot3d-sample-code:
@@ -449,6 +449,28 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot
        an interactive cutting plane.
        It can also be started without providing a file.
 
+:mod:`silx.gui.widgets` sample code
++++++++++++++++++++++++++++++++++++
+
+.. list-table::
+   :widths: 1 1 4
+   :header-rows: 1
+
+   * - Source
+     - Screenshot
+     - Description
+   * - :download:`floatedit.py <../../../examples/floatedit.py>`
+     - .. image:: img/floatedit.png
+         :width: 150px
+     - This script illustrates the use of :class:`silx.gui.widgets.FloatEdit.FloatEdit`.
+   * - :download:`stackedprogressbar.py <../../../examples/stackedprogressbar.py>`
+     - .. image:: img/stackedprogressbar.png
+         :width: 150px
+     - This script illustrates the use of :class:`silx.gui.widgets.StackedProgressBar.StackedProgressBar`.
+   * - :download:`waiterOverlay.py <../../../examples/waiterOverlay.py>`
+     - .. image:: img/waiterOverlay.png
+         :width: 150px
+     - Demonstration window that displays a wait icon until the plot is updated.
 
 :mod:`silx.io` sample code
 ++++++++++++++++++++++++++

examples/compareBackends.py

@@ -23,7 +23,7 @@
 # ###########################################################################*/
 
 """
-Compare one to one backend rendering
+This script compares the rendering of PlotWidget's matplotlib and OpenGL backends.
 """
 
 from __future__ import annotations

examples/floatedit.py

@@ -23,7 +23,7 @@
 #
 # ###########################################################################*/
 """
-Test FloatEdit widgets
+This script illustrates the use of :class:`silx.gui.widgets.FloatEdit.FloatEdit`.
 """
 
 from silx.gui import qt

examples/stackedprogressbar.py

@@ -23,7 +23,7 @@
 #
 # ###########################################################################*/
 """
-Test StackedProgressBar widgets
+This script illustrates the use of :class:`silx.gui.widgets.StackedProgressBar.StackedProgressBar`.
 """
 
 from silx.gui import qt