Working sphinx gallery

Author: dstansby

.gitignore

@@ -59,6 +59,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/auto_examples
 
 # MkDocs documentation
 /site/

docs/conf.py

@@ -17,34 +17,37 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'matplotlib-napari'
-copyright = '2022, David Stansby'
-author = 'David Stansby'
+project = "matplotlib-napari"
+copyright = "2022, David Stansby"
+author = "David Stansby"
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions = ["sphinx_gallery.gen_gallery"]
+
+sphinx_gallery_conf = {
+    "filename_pattern": ".",
+}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pydata_sphinx_theme'
+html_theme = "pydata_sphinx_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -10,6 +10,8 @@ Welcome to matplotlib-napari's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   auto_examples/index
+
 
 
 Indices and tables

examples/README.rst

@@ -0,0 +1,2 @@
+Examples
+========

examples/histogram.py

@@ -0,0 +1,14 @@
+"""
+Histograms
+==========
+"""
+import napari
+from skimage import data
+
+from napari_matplotlib import HistogramWidget
+
+viewer = napari.Viewer()
+viewer.add_image(data.brain())
+
+widget = HistogramWidget(viewer)
+widget

setup.cfg

@@ -31,8 +31,8 @@ project_urls =
 packages = find:
 install_requires =
     matplotlib
-    numpy
     napari
+    numpy
 python_requires = >=3.8
 include_package_data = True
 package_dir =
@@ -50,13 +50,15 @@ napari.manifest =
 [options.extras_require]
 docs =
     pydata-sphinx-theme
+    sphinx
+    sphinx-gallery
 testing =
     napari[pyqt5]
     pytest
     pytest-cov
     pytest-qt
-    pytest-xvfb ; sys_platform == 'linux'
     tox
+    pytest-xvfb;sys_platform == 'linux'
 
 [options.package_data]
 * = *.yaml

src/napari_matplotlib/_widget.py

@@ -1,3 +1,6 @@
+from base64 import b64encode
+from io import BytesIO
+
 import napari
 import numpy as np
 from matplotlib.backends.backend_qt5agg import FigureCanvas
@@ -7,32 +10,61 @@
 __all__ = ["HistogramWidget"]
 
 
-class HistogramWidget(QWidget):
+def _figure_to_base64(fig):
+    # Converts a matplotlib Figure to a base64 UTF-8 string
+    buf = BytesIO()
+    fig.savefig(
+        buf, format="png", facecolor="none"
+    )  # works better than transparent=True
+    return b64encode(buf.getvalue()).decode("utf-8")
+
+
+class NapariMPLWidget(QWidget):
+    """
+    Attributes
+    ----------
+    viewer : napari.viewer.Viewer
+        Main napari viewer.
+    figure : matplotlib.figure.Figure
+        Matplotlib figure.
+    canvas : matplotlib.backends.backend_qt5agg.FigureCanvas
+        Matplotlib canvas.
+    axes : matplotlib.axes.Axes
+        Matplotlib axes.
+    """
+
     def __init__(self, napari_viewer: napari.viewer.Viewer):
-        """
-        Widget to display a histogram of the currently selected layer.
-
-        Attributes
-        ----------
-        viewer : napari.viewer.Viewer
-            Main napari viewer.
-        layer : napari.layers.Layer
-            Current layer being histogrammed.
-        canvas : matplotlib.backends.backend_qt5agg.FigureCanvas
-            Matplotlib canvas.
-        axes : matplotlib.axes.Axes
-            Matplotlib axes.
-        """
         super().__init__()
-        self.viewer = napari_viewer
-        self.layer = self.viewer.layers[-1]
 
-        self.canvas = FigureCanvas(Figure(figsize=(5, 3)))
+        self.viewer = napari_viewer
+        self.figure = Figure(figsize=(5, 3))
+        self.canvas = FigureCanvas(self.figure)
         self.axes = self.canvas.figure.subplots()
 
         self.setLayout(QVBoxLayout())
         self.layout().addWidget(self.canvas)
 
+    def _repr_html_(self):
+        buf = BytesIO()
+        self.figure.savefig(buf, format="png", facecolor="none")
+        src = b64encode(buf.getvalue()).decode("utf-8")
+        return f"<img src='data:image/png;base64,{src}'/>"
+
+
+class HistogramWidget(NapariMPLWidget):
+    """
+    Widget to display a histogram of the currently selected layer.
+
+    Attributes
+    ----------
+    layer : napari.layers.Layer
+        Current layer being histogrammed.
+    """
+
+    def __init__(self, napari_viewer: napari.viewer.Viewer):
+        super().__init__(napari_viewer)
+        self.layer = self.viewer.layers[-1]
+
         self.viewer.dims.events.current_step.connect(self.hist_current_layer)
         self.viewer.layers.selection.events.active.connect(self.update_layer)