# 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](https://napari.org/community/mission_and_values.html), which includes more details on our vision for supporting a plugin ecosystem around napari.
You can see details of [the project roadmap here](https://napari.org/roadmaps/index.html).
## contributing
Contributions are encouraged! If you're new or unsure about anything check out our [issues tracker](https://github.com/napari/docs/issues) or reach out on [zulip](https://napari.zulipchat.com/) 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](https://napari.org/dev/developers/contributing/documentation/index.html) for more comprehensive information about contributing documentation.
### quickstart: local setup
* __Check the prerequisites__
1. Create a clean Python (>=3.10) environment (e.g., with conda).
1. In that environment, create an editable `napari` installation with the `docs` dependency group and a Qt backend. For example, after first forking and cloning the main `napari` project if you've not previously done so, run `python -m pip install -e ".[pyqt, docs]"` from your `napari/napari` clone directory. This will use the default Qt backend.
1. Fork *this* repository, `napari/docs`, 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`.
* __Build__ locally
* If you're building on Windows, a few extra steps are required; you can follow [this guide](https://napari.org/dev/developers/contributing/documentation/index.html#building-the-documentation-on-windows).
* From the root of your local clone of this repository, run one of these:
* `make html`, for a full build, including the example gallery
* `make html-noplot`, for a full build without building the example gallery
* `make slimfast`, for a *fast, parallel* build of only sources in the `docs` repository, with no notebook cell outputs and no example gallery.
Note: `-live` variants of these are available to auto-build when edited files are saved, e.g. `slimfast-live`. For more options, see [the documentation](https://napari.org/dev/developers/contributing/documentation/index.html#building-what-you-need).
* __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](https://napari.org/dev/developers/contributing/documentation/index.html).
## code of conduct
`napari` has a [Code of Conduct](https://napari.org/community/code_of_conduct.html) 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](https://napari.org/community/governance.html), which includes information about, and ways to contact the [@napari/steering-council and @napari/core-devs](https://napari.org/community/team.html#current-core-developers).
## citing napari
If you find `napari` useful please cite [this repository](https://github.com/napari/napari) using its DOI as follows:
> napari contributors (2019). napari: a multi-dimensional image viewer for python. [doi:10.5281/zenodo.3555620](https://zenodo.org/record/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](https://zenodo.org/record/3555620). 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](https://forum.image.sc/tags/napari) 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](https://github.com/napari/napari/issues/new?template=bug_report.md) 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
