diff --git a/docs/_static/hist.png b/docs/_static/hist.png new file mode 100644 index 00000000..95850b71 Binary files /dev/null and b/docs/_static/hist.png differ diff --git a/docs/changelog.rst b/docs/changelog.rst index db3bc343..75adbe4e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,7 +1,7 @@ Changelog ========= -0.3.0 +1.0.0 ----- New features diff --git a/docs/guide/index.rst b/docs/guide/index.rst deleted file mode 100644 index 968ea0ec..00000000 --- a/docs/guide/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Guide -===== - -.. toctree:: - :maxdepth: 1 - - user_guide - third_party diff --git a/docs/index.rst b/docs/index.rst index 5b747e04..b457fdde 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,23 +1,21 @@ napari-matplotlib ================= -``napari-matplotlib`` is a `Napari `_ plugin for generating +A `napari `_ plugin for generating `Matplotlib `_ plots from one or more ``napari`` Layers. -Design ------- -``napari-matplotlib`` contains a number of different ``napari`` Widgets. Each -widget is designed to map one or more ``napari`` Layers on to a ``matplotlib`` plot. +This plugin provides 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: 1 - - guide/index +.. image:: _static/hist.png + :alt: Screenshot of the napari viewer showing the napari-matplotlib histogram widget on the right hand side of the screen. .. toctree:: :maxdepth: 1 - :caption: Reference + :hidden: + user_guide + third_party api changelog diff --git a/docs/guide/third_party.rst b/docs/third_party.rst similarity index 94% rename from docs/guide/third_party.rst rename to docs/third_party.rst index d892ba8d..c09eb532 100644 --- a/docs/guide/third_party.rst +++ b/docs/third_party.rst @@ -1,8 +1,6 @@ Third-party plugins =================== -This page explains how ``napari-matplotlib`` can be used within third party plugins. - -``napari-matplotlib`` provides a ready-to-go widget with a Matplotlib toolbar and figure to third party plugin developers +``napari-matplotlib`` provides a ready-to-go widget with a Matplotlib toolbar and figure to third party plugin developers. This widget is customised to match the theme of the main napari window. The widget can be found at `napari_matplotlib.base.NapariMPLWidget`. diff --git a/docs/guide/user_guide.rst b/docs/user_guide.rst similarity index 100% rename from docs/guide/user_guide.rst rename to docs/user_guide.rst