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

Skip to content

Misc dox fixes #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/hist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
=========

0.3.0
1.0.0
-----

New features
Expand Down
8 changes: 0 additions & 8 deletions docs/guide/index.rst

This file was deleted.

18 changes: 8 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
napari-matplotlib
=================
``napari-matplotlib`` is a `Napari <https://napari.org>`_ plugin for generating
A `napari <https://napari.org>`_ plugin for generating
`Matplotlib <https://matplotlib.org/>`_ 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
4 changes: 1 addition & 3 deletions docs/guide/third_party.rst → docs/third_party.rst
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
File renamed without changes.