Merge branch 'main' into add-feature-histogram

Author: dstansby

.github/workflows/docs.yml

@@ -1,9 +1,15 @@
 name: Build docs
 
 on:
+
   pull_request:
     branches:
       - main
+  push:
+    branches:
+      - main
+    tags:
+      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
   build-docs:
@@ -40,7 +46,7 @@ jobs:
     name: Upload docs to GitHub pages
     runs-on: ubuntu-latest
     needs: build-docs
-    if: github.event_name == 'push' && github.ref_name == 'main'
+    if: contains(github.ref, 'tags')
     steps:
     - uses: actions/checkout@v3
     - uses: actions/download-artifact@v3
@@ -52,4 +58,4 @@ jobs:
       with:
         folder: html
         ssh-key: ${{ secrets.DEPLOY_KEY }}
-        repository-name: dstansby/napari-matplotlib-docs
+        repository-name: napari-matplotlib/napari-matplotlib.github.io

.github/workflows/test_and_deploy.yml

@@ -73,21 +73,24 @@ jobs:
     needs: [test]
     runs-on: ubuntu-latest
     if: contains(github.ref, 'tags')
+    environment: pypi-deploy
+    permissions:
+      id-token: write
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: "3.x"
-      - name: Install dependencies
+      - name: Install build
         run: |
           python -m pip install --upgrade pip
-          pip install -U setuptools setuptools_scm wheel twine build
-      - name: Build and publish
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }}
+          python -m pip install --upgrade build
+
+      - name: Build package
         run: |
           git tag
           python -m build .
-          twine upload dist/*
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -6,13 +6,8 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
-  - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.3.0
-    hooks:
-      - id: setup-cfg-fmt
-
   - repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 23.7.0
     hooks:
       - id: black
 
@@ -22,14 +17,14 @@ repos:
       - id: napari-plugin-checks
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.3.0
+    rev: v1.5.1
     hooks:
      - id: mypy
        additional_dependencies: [numpy, matplotlib]
 
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
+  - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.0.272'
+    rev: 'v0.0.285'
     hooks:
       - id: ruff
 

README.md

@@ -5,7 +5,6 @@
 [![Python Version](https://img.shields.io/pypi/pyversions/napari-matplotlib.svg?color=green)](https://python.org)
 [![tests](https://github.com/matplotlib/napari-matplotlib/workflows/tests/badge.svg)](https://github.com/matplotlib/napari-matplotlib/actions)
 [![codecov](https://codecov.io/gh/matplotlib/napari-matplotlib/branch/main/graph/badge.svg)](https://codecov.io/gh/matplotlib/napari-matplotlib)
-[![readthedocs](https://readthedocs.org/projects/napari-matplotlib/badge/?version=latest)](https://napari-matplotlib.readthedocs.io/en/latest/)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/matplotlib/pytest-mpl/master.svg)](https://results.pre-commit.ci/latest/github/matplotlib/pytest-mpl/master)
 [![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-matplotlib)](https://napari-hub.org/plugins/napari-matplotlib)
 

docs/_static/hist.png

@@ -1,7 +1,40 @@
 Changelog
 =========
+1.0.3
+-----
+Changes
+~~~~~~~
+- The slice widget is now limited to slicing along the x/y dimensions. Support
+  for slicing along z has been removed for now to make the code simpler.
+- The slice widget now uses a slider to select the slice value.
+
+Bug fixes
+~~~~~~~~~
+- Fixed creating 1D slices of 2D images.
+- Removed the limitation that only the first 99 indices could be sliced using
+  the slice widget.
+
+1.0.2
+-----
+Bug fixes
+~~~~~~~~~
+- A full dataset is no longer read into memory when using ``HistogramWidget``.
+  Only the current slice is loaded.
+- Fixed compatibility with napari 0.4.18.
+
+Changes
+~~~~~~~
+- Histogram bin limits are now caclualted from the slice being histogrammed, and
+  not the whole dataset. This is as a result of the above bug fix.
+
+1.0.1
+-----
+Bug fixes
+~~~~~~~~~
+- Pinned that maximum version of `napari` to 0.4.17, since ``napari-matplotlib``
+  does not yet work with ``napari`` 0.4.18.
 
-0.3.0
+1.0.0
 -----
 
 New features
@@ -15,6 +48,8 @@ Visual improvements
 ~~~~~~~~~~~~~~~~~~~
 - The background of ``napari-matplotlib`` figures and axes is now transparent, and the text and axis colour respects the ``napari`` theme.
 - The icons in the Matplotlib toolbar are now the same size as icons in the napari window.
+- Custom style sheets can now be set to customise plots. See the user guide
+  for more information.
 
 Changes
 ~~~~~~~

docs/_static/logo.png

@@ -87,6 +87,7 @@
 # a list of builtin themes.
 #
 html_theme = "pydata_sphinx_theme"
+html_logo = "_static/logo.png"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/changelog.rst

@@ -1,23 +1,22 @@
 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
+   auto_examples/index
+   third_party
    api
    changelog