Use qtgallery for sphinx gallery

Author: dstansby

docs/conf.py

@@ -13,7 +13,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+import qtgallery
 
 # -- Project information -----------------------------------------------------
 
@@ -31,6 +31,8 @@
 
 sphinx_gallery_conf = {
     "filename_pattern": ".",
+    "image_scrapers": (qtgallery.qtscraper,),
+    "reset_modules": (qtgallery.reset_qapp,),
 }
 
 # Add any paths that contain templates here, relative to this directory.

examples/histogram.py

@@ -5,10 +5,12 @@
 import napari
 from skimage import data
 
-from napari_matplotlib import HistogramWidget
-
 viewer = napari.Viewer()
 viewer.add_image(data.brain())
 
-widget = HistogramWidget(viewer)
-widget
+viewer.window.add_plugin_dock_widget(
+    plugin_name="napari-matplotlib", widget_name="Histogram"
+)
+
+if __name__ == "__main__":
+    napari.run()

setup.cfg

@@ -50,6 +50,7 @@ napari.manifest =
 [options.extras_require]
 docs =
     pydata-sphinx-theme
+    qtgallery
     sphinx
     sphinx-gallery
 testing =

src/napari_matplotlib/_widget.py

@@ -1,6 +1,3 @@
-from base64 import b64encode
-from io import BytesIO
-
 import napari
 import numpy as np
 from matplotlib.backends.backend_qt5agg import FigureCanvas
@@ -10,15 +7,6 @@
 __all__ = ["HistogramWidget"]
 
 
-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
@@ -37,19 +25,13 @@ def __init__(self, napari_viewer: napari.viewer.Viewer):
         super().__init__()
 
         self.viewer = napari_viewer
-        self.figure = Figure(figsize=(5, 3))
+        self.figure = Figure(figsize=(5, 3), tight_layout=True)
         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):
     """

src/napari_matplotlib/napari.yaml

@@ -8,4 +8,4 @@ contributions:
 
   widgets:
     - command: napari-matplotlib.histogram
-      display_name: Matplotlib histogram
+      display_name: Histogram

test.py

@@ -3,7 +3,7 @@
 viewer = napari.Viewer()
 viewer.open_sample("napari", "kidney")
 viewer.window.add_plugin_dock_widget(
-    plugin_name="napari-matplotlib", widget_name="Matplotlib histogram"
+    plugin_name="napari-matplotlib", widget_name="Histogram"
 )
 
 if __name__ == "__main__":