Add some design info

Author: dstansby

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -W
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build

docs/conf.py

@@ -31,6 +31,7 @@
     "numpydoc",
     "sphinx_gallery.gen_gallery",
     "sphinx_automodapi.automodapi",
+    "sphinx_automodapi.smart_resolver",
 ]
 
 sphinx_gallery_conf = {
@@ -49,6 +50,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+default_role = "py:obj"
 
 # -- Options for HTML output -------------------------------------------------
 

docs/index.rst

@@ -1,13 +1,17 @@
-.. matplotlib-napari documentation master file, created by
-   sphinx-quickstart on Fri Apr 29 20:57:13 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+matplotlib-napari
+=================
+``matplotlib-napari`` is a ``napari`` plugin for generating ``Matplotlib`` plots
+from one or more ``napari`` Layers.
 
-Welcome to matplotlib-napari's documentation!
-=============================================
+Design
+------
+``matplotlib-napari`` contains a number of different ``napari`` widgets. Each
+widget is designed to map one or more ``napari`` Layers on to a ``Matplotlib``
+plot. As an example, the `~.HistogramWidget` is used to
+map one or more Image layers on to a 1D histogram plot.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    auto_examples/index

src/napari_matplotlib/__init__.py

@@ -4,4 +4,4 @@
     __version__ = "unknown"
 
 
-from ._widget import *  # NoQA
+from .histogram import *  # NoQA