Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a67b34c

Browse files
authored
Merge pull request #179 from dstansby/doc-fixes
Misc dox fixes
2 parents 40f63d7 + 3e469a9 commit a67b34c

File tree

6 files changed

+10
-22
lines changed

6 files changed

+10
-22
lines changed

docs/_static/hist.png

1.06 MB
Loading

docs/changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Changelog
22
=========
33

4-
0.3.0
4+
1.0.0
55
-----
66

77
New features

docs/guide/index.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/index.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
napari-matplotlib
22
=================
3-
``napari-matplotlib`` is a `Napari <https://napari.org>`_ plugin for generating
3+
A `napari <https://napari.org>`_ plugin for generating
44
`Matplotlib <https://matplotlib.org/>`_ plots from one or more ``napari`` Layers.
55

6-
Design
7-
------
8-
``napari-matplotlib`` contains a number of different ``napari`` Widgets. Each
9-
widget is designed to map one or more ``napari`` Layers on to a ``matplotlib`` plot.
6+
This plugin provides a number of different ``napari`` Widgets. Each
7+
widget is designed to map one or more ``napari`` Layers on to a ``Matplotlib`` plot.
108
As an example, the `~.HistogramWidget` is used to
119
map one or more Image layers on to a 1D histogram plot.
1210

13-
.. toctree::
14-
:maxdepth: 1
15-
16-
guide/index
11+
.. image:: _static/hist.png
12+
:alt: Screenshot of the napari viewer showing the napari-matplotlib histogram widget on the right hand side of the screen.
1713

1814
.. toctree::
1915
:maxdepth: 1
20-
:caption: Reference
16+
:hidden:
2117

18+
user_guide
19+
third_party
2220
api
2321
changelog

docs/guide/third_party.rst renamed to docs/third_party.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
Third-party plugins
22
===================
3-
This page explains how ``napari-matplotlib`` can be used within third party plugins.
4-
5-
``napari-matplotlib`` provides a ready-to-go widget with a Matplotlib toolbar and figure to third party plugin developers
3+
``napari-matplotlib`` provides a ready-to-go widget with a Matplotlib toolbar and figure to third party plugin developers.
64
This widget is customised to match the theme of the main napari window.
75

86
The widget can be found at `napari_matplotlib.base.NapariMPLWidget`.
File renamed without changes.

0 commit comments

Comments
 (0)