Refactor documentation generation: remove unused processor methods CSV files and update related commands

Author: PierreRaybaut

.vscode/tasks.json

@@ -289,7 +289,7 @@
         },
         {
             "label": "🛠️ Generate doc assets",
-            "command": "${command:python.interpreterPath} -m guidata.utils.genreqs all && ${command:python.interpreterPath} doc/update_validation_status.py && ${command:python.interpreterPath} doc/update_processor_methods.py",
+            "command": "${command:python.interpreterPath} -m guidata.utils.genreqs all && ${command:python.interpreterPath} doc/update_validation_status.py",
             "options": {
                 "cwd": "${workspaceFolder}",
                 "statusbar": {

datalab/proxy.py

@@ -48,8 +48,6 @@
 
 .. autofunction:: proxy_context
 
-.. _processor_methods:
-
 Calling processor methods using proxy objects
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -71,54 +69,6 @@
     p = sigima.params.MovingAverageParam.create(n=30)
     proxy.calc("moving_average", p)
 
-2. Directly calling the processor method from the proxy object:
-
-.. code-block:: python
-
-    # Call a method without parameter
-    proxy.compute_average()
-
-    # Call a method with parameters
-    p = sigima.params.MovingAverageParam.create(n=30)
-    proxy.compute_moving_average(p)
-
-.. warning::
-
-    The `compute_{name}` methods are not statically defined in the proxy classes (and
-    not even dynamically). They are nevertheless available through the proxy objects
-    thanks to the magic method :meth:`__getattr__` which forwards the call to the
-    :meth:`calc` method. However, this means that the methods are not listed in the
-    proxy classes documentation, and they are not available in the auto-completion
-    feature of your IDE.
-
-Number of compute methods
-*************************
-
-.. csv-table:: Number of compute methods
-   :file: ../doc/processor_methods_nb.csv
-   :header: Signal, Image, Total
-
-Signal processing
-*****************
-
-The following table lists the signal processor methods - it is automatically
-generated from the source code:
-
-.. csv-table:: Signal processor methods
-   :file: ../doc/processor_methods_signal.csv
-   :header: Compute method, Description
-   :widths: 40, 60
-
-Image processing
-****************
-
-The following table lists the image processor methods - it is automatically
-generated from the source code:
-
-.. csv-table:: Image processor methods
-    :file: ../doc/processor_methods_image.csv
-    :header: Compute method, Description
-    :widths: 40, 60
 """
 
 from __future__ import annotations
@@ -150,11 +100,6 @@ class RemoteProxy(RemoteClient):
         ValueError: Invalid timeout (must be >= 0.0)
         ValueError: Invalid number of retries (must be >= 1)
 
-    .. note::
-
-        The proxy object also allows to access DataLab computing methods exposed by
-        the processor classes (see :ref:`processor_methods`).
-
     Examples:
         Here is a simple example of how to use RemoteProxy in a Python script
         or in a Jupyter notebook:
@@ -192,11 +137,6 @@ class LocalProxy(BaseProxy):
 
     Args:
         datalab (DLMainWindow): DLMainWindow instance.
-
-    .. note::
-
-        The proxy object also allows to access DataLab computing methods exposed by
-        the processor classes (see :ref:`processor_methods`).
     """
 
     def add_signal(

doc/locale/fr/LC_MESSAGES/api/proxy.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DataLab \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-07-08 15:38+0200\n"
+"POT-Creation-Date: 2025-07-08 17:54+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -55,9 +55,6 @@ msgstr ""
 msgid "Invalid number of retries (must be >= 1)"
 msgstr ""
 
-msgid "The proxy object also allows to access DataLab computing methods exposed by the processor classes (see :ref:`processor_methods`)."
-msgstr ""
-
 msgid "Examples"
 msgstr ""
 
@@ -484,196 +481,3 @@ msgstr ""
 msgid "To run a computation feature associated to a processor, you can use the :meth:`calc` method of the proxy object:"
 msgstr ""
 
-msgid "Directly calling the processor method from the proxy object:"
-msgstr ""
-
-#, python-brace-format
-msgid "The `compute_{name}` methods are not statically defined in the proxy classes (and not even dynamically). They are nevertheless available through the proxy objects thanks to the magic method :meth:`__getattr__` which forwards the call to the :meth:`calc` method. However, this means that the methods are not listed in the proxy classes documentation, and they are not available in the auto-completion feature of your IDE."
-msgstr ""
-
-msgid "Number of compute methods"
-msgstr ""
-
-msgid "Signal"
-msgstr ""
-
-msgid "Image"
-msgstr ""
-
-msgid "Total"
-msgstr ""
-
-msgid "11"
-msgstr ""
-
-msgid "14"
-msgstr ""
-
-msgid "25"
-msgstr ""
-
-msgid "Signal processing"
-msgstr ""
-
-msgid "The following table lists the signal processor methods - it is automatically generated from the source code:"
-msgstr ""
-
-msgid "Signal processor methods"
-msgstr ""
-
-msgid "Compute method"
-msgstr ""
-
-msgid "Description"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_all_stability`"
-msgstr ""
-
-msgid "Compute all stability analysis features"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_fit`"
-msgstr ""
-
-msgid "Compute fitting curve using an interactive dialog"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_full_width_at_y`"
-msgstr ""
-
-msgid "Compute full width at a given y"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_multigaussianfit`"
-msgstr ""
-
-msgid "Compute multi-Gaussian fitting curve using an interactive dialog"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_multiple_1_to_1`"
-msgstr ""
-
-msgid "Generic processing method: 1 object in → n objects out"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_offset_correction`"
-msgstr ""
-
-msgid "Compute offset correction"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_peak_detection`"
-msgstr ""
-
-msgid "Detect peaks from data"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_polyfit`"
-msgstr ""
-
-msgid "Compute polynomial fitting curve"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_roi_extraction`"
-msgstr ""
-
-msgid "Extract Region Of Interest (ROI) from data"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_x_at_y`"
-msgstr ""
-
-msgid "Compute x at y with :py:func:`sigima.proc.signal.x_at_y`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.signal.SignalProcessor.compute_y_at_x`"
-msgstr ""
-
-msgid "Compute y at x with :py:func:`sigima.proc.signal.y_at_x`"
-msgstr ""
-
-msgid "Image processing"
-msgstr ""
-
-msgid "The following table lists the image processor methods - it is automatically generated from the source code:"
-msgstr ""
-
-msgid "Image processor methods"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_all_denoise`"
-msgstr ""
-
-msgid "Compute all denoising filters"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_all_edges`"
-msgstr ""
-
-msgid "Compute all edges filters"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_all_morphology`"
-msgstr ""
-
-msgid "Compute all morphology filters"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_all_threshold`"
-msgstr ""
-
-msgid "Compute all threshold algorithms"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_average_profile`"
-msgstr ""
-
-msgid "Compute average profile"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_binning`"
-msgstr ""
-
-msgid "Binning image with :py:func:`sigima.proc.image.binning`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_line_profile`"
-msgstr ""
-
-msgid "Compute profile along a vertical or horizontal line"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_multiple_1_to_1`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_offset_correction`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_peak_detection`"
-msgstr ""
-
-msgid "Compute 2D peak detection"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_radial_profile`"
-msgstr ""
-
-msgid "Compute radial profile"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_resize`"
-msgstr ""
-
-msgid "Resize image with :py:func:`sigima.proc.image.resize`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_roi_extraction`"
-msgstr ""
-
-msgid ":py:func:`~datalab.gui.processor.image.ImageProcessor.compute_segment_profile`"
-msgstr ""
-
-msgid "Compute profile along a segment"
-msgstr ""
-