Add documentation for DataLab-Kernel

- Created API documentation for the Workspace class and its components.
- Added development setup guide and contribution guidelines.
- Introduced user guide sections covering installation, getting started, features, and overview.
- Included example notebooks demonstrating basic usage, live mode, and persistence.
- Updated pyproject.toml to include documentation dependencies.

Author: PierreRaybaut

doc/_static/DataLab-Banner.svg

@@ -0,0 +1,16 @@
+/* Custom CSS for DataLab-Kernel documentation */
+
+/* Dark/light mode support for images */
+.dark-light {
+    filter: invert(0);
+}
+
+html[data-theme="dark"] .dark-light {
+    filter: invert(1);
+}
+
+/* Remove scaling on logo */
+.no-scaled-link img {
+    max-width: 100%;
+    height: auto;
+}

doc/_static/DataLab-Kernel-Banner.svg

@@ -0,0 +1,33 @@
+.. _api:
+
+API Reference
+=============
+
+The public API of DataLab-Kernel provides a simple interface for
+scientific data processing in Jupyter notebooks.
+
+.. list-table::
+    :header-rows: 1
+    :align: left
+
+    * - Module
+      - Purpose
+
+    * - :mod:`datalab_kernel`
+      - Main entry point with ``Workspace``, ``Plotter``, and ``WorkspaceMode``
+
+    * - :mod:`datalab_kernel.objects`
+      - Data objects (``SignalObj``, ``ImageObj``) and creation functions
+        (``create_signal``, ``create_image``) - re-exported from Sigima
+
+    * - :mod:`datalab_kernel.workspace`
+      - Workspace implementation with backend abstraction
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Modules:
+
+   workspace
+   objects
+   plotter

doc/_static/custom.css

@@ -0,0 +1,125 @@
+.. _api_objects:
+
+Objects
+=======
+
+Data objects for signals and images, re-exported from Sigima.
+
+.. automodule:: datalab_kernel.objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SignalObj
+---------
+
+The ``SignalObj`` class represents 1D signal data with X/Y arrays,
+optional error bars, metadata, units, and labels.
+
+See `Sigima SignalObj documentation <https://sigima.readthedocs.io/en/latest/api/objects.html>`_
+for complete details.
+
+Basic usage:
+
+.. code-block:: python
+
+    from datalab_kernel.objects import SignalObj, create_signal
+    import numpy as np
+
+    # Using create_signal (recommended)
+    signal = create_signal(
+        "My Signal",
+        np.linspace(0, 10, 100),
+        np.sin(np.linspace(0, 10, 100)),
+        units=("s", "V"),
+        labels=("Time", "Voltage"),
+    )
+
+    # Direct instantiation
+    signal = SignalObj()
+    signal.set_xydata(x_array, y_array)
+    signal.title = "My Signal"
+
+
+ImageObj
+--------
+
+The ``ImageObj`` class represents 2D image data with metadata,
+coordinate system, units, and labels.
+
+See `Sigima ImageObj documentation <https://sigima.readthedocs.io/en/latest/api/objects.html>`_
+for complete details.
+
+Basic usage:
+
+.. code-block:: python
+
+    from datalab_kernel.objects import ImageObj, create_image
+    import numpy as np
+
+    # Using create_image (recommended)
+    image = create_image(
+        "My Image",
+        np.random.rand(256, 256),
+        units=("mm", "mm", "counts"),
+        labels=("X", "Y", "Intensity"),
+    )
+
+    # Direct instantiation
+    image = ImageObj()
+    image.data = data_2d
+    image.title = "My Image"
+
+
+create_signal
+-------------
+
+Factory function for creating signal objects.
+
+.. code-block:: python
+
+    create_signal(
+        title: str,
+        x: np.ndarray | None = None,
+        y: np.ndarray | None = None,
+        dx: np.ndarray | None = None,
+        dy: np.ndarray | None = None,
+        metadata: dict | None = None,
+        units: tuple[str, str] | None = None,
+        labels: tuple[str, str] | None = None,
+    ) -> SignalObj
+
+**Parameters:**
+
+- ``title``: Signal title
+- ``x``: X data array
+- ``y``: Y data array
+- ``dx``: X error bars (optional)
+- ``dy``: Y error bars (optional)
+- ``metadata``: Additional metadata dictionary
+- ``units``: Tuple of (x_unit, y_unit)
+- ``labels``: Tuple of (x_label, y_label)
+
+
+create_image
+------------
+
+Factory function for creating image objects.
+
+.. code-block:: python
+
+    create_image(
+        title: str,
+        data: np.ndarray | None = None,
+        metadata: dict | None = None,
+        units: tuple | None = None,
+        labels: tuple | None = None,
+    ) -> ImageObj
+
+**Parameters:**
+
+- ``title``: Image title
+- ``data``: 2D data array
+- ``metadata``: Additional metadata dictionary
+- ``units``: Tuple of (x_unit, y_unit, z_unit)
+- ``labels``: Tuple of (x_label, y_label, z_label)

doc/api/index.rst

@@ -0,0 +1,56 @@
+.. _api_plotter:
+
+Plotter
+=======
+
+The ``Plotter`` class provides visualization for workspace objects.
+
+.. automodule:: datalab_kernel.plotter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Usage
+-----
+
+.. code-block:: python
+
+    from datalab_kernel import Workspace, Plotter
+
+    workspace = Workspace()
+    plotter = Plotter(workspace)
+
+    # Add some objects
+    workspace.add("signal", signal_obj)
+    workspace.add("image", image_obj)
+
+    # Plot by name
+    plotter.plot("signal")
+    plotter.plot("image")
+
+Signal Plotting
+---------------
+
+Signals are plotted as line plots:
+
+.. code-block:: python
+
+    plotter.plot("my_signal")
+
+    # With custom options
+    plotter.plot("my_signal", color="red", linewidth=2)
+
+Image Plotting
+--------------
+
+Images are displayed as 2D colormaps:
+
+.. code-block:: python
+
+    plotter.plot("my_image")
+
+    # With colormap and colorbar
+    plotter.plot("my_image", cmap="viridis", colorbar=True)
+
+    # With specific value range
+    plotter.plot("my_image", vmin=0, vmax=100)

doc/api/objects.rst

@@ -0,0 +1,39 @@
+.. _api_workspace:
+
+Workspace
+=========
+
+The ``Workspace`` class is the central API for managing data objects.
+
+.. automodule:: datalab_kernel.workspace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+WorkspaceMode
+-------------
+
+.. autoclass:: datalab_kernel.workspace.WorkspaceMode
+   :members:
+   :undoc-members:
+
+Workspace Class
+---------------
+
+.. autoclass:: datalab_kernel.workspace.Workspace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Backend Classes
+---------------
+
+.. autoclass:: datalab_kernel.workspace.StandaloneBackend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoclass:: datalab_kernel.workspace.LiveBackend
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/api/plotter.rst

@@ -0,0 +1,96 @@
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+# pylint: skip-file
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+import datalab_kernel
+
+# -- Project information -----------------------------------------------------
+
+project = "DataLab-Kernel"
+author = "DataLab Platform Developers"
+copyright = "2025, DataLab Platform Developers"
+release = datalab_kernel.__version__
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "myst_nb",  # Markdown and notebook support
+    "sphinx_design",
+    "sphinx_copybutton",
+]
+
+# MyST-NB configuration
+nb_execution_mode = "off"  # Don't re-execute notebooks during build
+nb_execution_timeout = 180  # Timeout for notebook execution (if enabled)
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# Suppress some warnings
+suppress_warnings = ["config.cache"]
+
+# -- Options for HTML output -------------------------------------------------
+html_theme = "pydata_sphinx_theme"
+html_title = project
+html_logo = "_static/DataLab-Kernel-Banner.svg"
+html_favicon = "_static/favicon.ico"
+html_show_sourcelink = False
+
+html_theme_options = {
+    "show_toc_level": 2,
+    "github_url": "https://github.com/DataLab-Platform/DataLab-Kernel/",
+    "logo": {
+        "text": f"v{datalab_kernel.__version__}",
+    },
+    "icon_links": [
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/datalab-kernel",
+            "icon": "_static/pypi.svg",
+            "type": "local",
+            "attributes": {"target": "_blank"},
+        },
+        {
+            "name": "DataLab",
+            "url": "https://datalab-platform.com",
+            "icon": "_static/DataLab.svg",
+            "type": "local",
+            "attributes": {"target": "_blank"},
+        },
+    ],
+}
+html_static_path = ["_static"]
+
+# -- Options for LaTeX output ------------------------------------------------
+latex_logo = "_static/DataLab-Kernel-Banner.png"
+
+# -- Options for sphinx-intl package -----------------------------------------
+locale_dirs = ["locale/"]
+gettext_compact = False
+gettext_location = False
+
+# -- Options for autodoc extension -------------------------------------------
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+}
+
+# -- Options for intersphinx extension ---------------------------------------
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "sigima": ("https://sigima.readthedocs.io/en/latest/", None),
+    "datalab": ("https://datalab-platform.readthedocs.io/en/latest/", None),
+    "ipykernel": ("https://ipykernel.readthedocs.io/en/stable/", None),
+}