napari docs

This repository contains the sources for the napari documentation. This includes tutorials, how-tos and other narrative documentation. The autogenerated API documentation is extracted from the source code docstrings, which live on https://github.com/napari/napari

mission, values, and roadmap

For more information about our plans for napari you can read our mission and values statement, which includes more details on our vision for supporting a plugin ecosystem around napari. You can see details of the project roadmap here.

contributing

Contributions are encouraged! If you're new or unsure about anything check out our issues tracker or reach out on zulip before jumping in. It's nice to be able preview how your contribution will look on the web, so here we provide a brief summary of what's required for a local setup that will allow you to do so. Alternatively, our CI setup provides a preview link that shows your changes. Please read our contributing guide for more comprehensive information about contributing documentation.

quickstart: local setup

• Check the prerequisites
  1. Create a clean Python environment (e.g., with conda).
  2. In that environment, create a development installation of napari on your local machine, first forking and cloning the main napari project if you've not previously done so.
  3. Fork this repository, and then clone your fork to your local machine. NB: you may want to name your fork e.g. napari-docs rather than just docs.
  4. With your local clone's root folder as the working directory, and with the environment created in the first step activated, install the docs requirements with python -m pip install -r requirements.txt.
• Build locally
  • If you're building on Windows, a few extra steps are required; you can follow this guide.
  • From the root of your local clone of this repository, run one of these:
    • make docs, if your changes include the example gallery
    • make docs-install && make html-noplot, otherwise
• Preview locally, either dragging-and-dropping docs/_build/index.html into a browser, or deploying a local server with python3 -m http.server --directory docs/_build.

These steps should set you up to build and preview your docs contributions on your local machine. For more detailed instructions and tips, please visit the relevant sections of our contribution guide.

code of conduct

napari has a Code of Conduct that should be honored by everyone who participates in the napari community.

governance

You can learn more about how the napari project is organized and managed from our governance model, which includes information about, and ways to contact the @napari/steering-council and @napari/core-devs.

citing napari

If you find napari useful please cite this repository using its DOI as follows:

napari contributors (2019). napari: a multi-dimensional image viewer for python. doi:10.5281/zenodo.3555620

Note this DOI will resolve to all versions of napari. To cite a specific version please find the DOI of that version on our zenodo page. The DOI of the latest version is in the badge at the top of this page.

help

We're a community partner on the image.sc forum and all help and support requests should be posted on the forum with the tag napari. We look forward to interacting with you there.

Bug reports should be made on our github issues using the bug report template. If you think something isn't working, don't hesitate to reach out - it is probably us and not you!

institutional and funding partners