Add API docs

Author: dstansby

.gitignore

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

docs/api.rst

@@ -0,0 +1,10 @@
+API reference
+=============
+This section documents the internal API of ``napari-matplotlib`` classes.
+Most users shouldn't need this, and will just directly interact with the
+plots though the napari user interface.
+
+
+.. automodapi:: napari_matplotlib
+
+.. automodapi:: napari_matplotlib.base

docs/api/napari_matplotlib.HistogramWidget.rst

@@ -0,0 +1,19 @@
+HistogramWidget
+===============
+
+.. currentmodule:: napari_matplotlib
+
+.. autoclass:: HistogramWidget
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~HistogramWidget.hist_current_layer
+      ~HistogramWidget.update_layer
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: hist_current_layer
+   .. automethod:: update_layer

docs/conf.py

@@ -27,14 +27,20 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx_gallery.gen_gallery"]
+extensions = [
+    "numpydoc",
+    "sphinx_gallery.gen_gallery",
+    "sphinx_automodapi.automodapi",
+]
 
 sphinx_gallery_conf = {
     "filename_pattern": ".",
     "image_scrapers": (qtgallery.qtscraper,),
     "reset_modules": (qtgallery.reset_qapp,),
 }
 
+numpydoc_show_class_members = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

docs/index.rst

@@ -11,6 +11,7 @@ Welcome to matplotlib-napari's documentation!
    :caption: Contents:
 
    auto_examples/index
+   api
 
 
 

setup.cfg

@@ -49,9 +49,11 @@ napari.manifest =
 
 [options.extras_require]
 docs =
+    numpydoc
     pydata-sphinx-theme
     qtgallery
     sphinx
+    sphinx-automodapi
     sphinx-gallery
 testing =
     napari[pyqt5]

src/napari_matplotlib/_widget.py

@@ -1,36 +1,9 @@
 import napari
 import numpy as np
-from matplotlib.backends.backend_qt5agg import FigureCanvas
-from matplotlib.figure import Figure
-from qtpy.QtWidgets import QVBoxLayout, QWidget
-
-__all__ = ["HistogramWidget"]
 
+from .base import NapariMPLWidget
 
-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):
-        super().__init__()
-
-        self.viewer = napari_viewer
-        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)
+__all__ = ["HistogramWidget"]
 
 
 class HistogramWidget(NapariMPLWidget):

src/napari_matplotlib/base.py

@@ -0,0 +1,32 @@
+import napari
+from matplotlib.backends.backend_qt5agg import FigureCanvas
+from matplotlib.figure import Figure
+from qtpy.QtWidgets import QVBoxLayout, QWidget
+
+__all__ = ["NapariMPLWidget"]
+
+
+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):
+        super().__init__()
+
+        self.viewer = napari_viewer
+        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)