Skip to content
Open
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
1 change: 1 addition & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ subtrees:
- entries:
- file: plugins/testing_and_publishing/test
- file: plugins/testing_and_publishing/deploy
- file: plugins/testing_and_publishing/hub_customization
- file: plugins/testing_workshop_docs/index
subtrees:
- entries:
Expand Down
32 changes: 11 additions & 21 deletions docs/plugins/testing_and_publishing/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,16 @@ template, this has already been done for you.)

Once your package is listed on [PyPI] (and includes the `Framework :: napari`
[classifier]), it will also be visible on the [napari
hub](https://napari-hub.org/). To ensure you are providing the relevant metadata and
description for your plugin, see the following documentation in the [napari hub
wiki](https://github.com/chanzuckerberg/napari-hub/wiki/Plugin-Developer's-Guide-to-the-napari-hub):

- [Customizing your plugin’s
listing](https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing)
- [Writing the perfect description for your
plugin](https://github.com/chanzuckerberg/napari-hub/wiki/Writing-the-Perfect-Description-for-your-Plugin)

```{admonition} The hub
For more about the napari hub, see the [napari hub About
page](https://www.napari-hub.org/about). To learn more about the hub’s
development process, see the [napari hub GitHub’s
Wiki](https://github.com/chanzuckerberg/napari-hub/wiki).

If you want your plugin to be available on PyPI, but not visible on the napari
hub, add a `visibility` flag to your plugin manifest. For more details, see the
[manifest reference](plugin-manifest) and napari hub [customization
guide](https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing#visibility).
```
hub](https://napari-hub.org/).

To ensure you are providing the best metadata and description for your plugin,
see our comprehensive guide: [](hub-customization). This guide covers:

- Setting package metadata in `pyproject.toml`
- Using npe2 manifest metadata for hub display
- Creating hub-specific configuration files
- Adding citation information
- Controlling plugin visibility

## Deployment

Expand Down Expand Up @@ -57,4 +47,4 @@ forum](https://forum.image.sc/tag/napari).
[autodeploy]: https://github.com/napari/napari-plugin-template#set-up-automatic-deployments
[classifier]: https://pypi.org/classifiers/
[pypi]: https://pypi.org/
[pypi-upload]: https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives
[pypi-upload]: https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives
Loading