Skip to content

Commit

Permalink
take PR feedback suggestions -- https://github.com/napari/docs/pull/3…
Browse files Browse the repository at this point in the history
  • Loading branch information
vreuter committed Mar 10, 2024
1 parent 21fb2a6 commit cc35c2a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Please read our [contributing guide](https://napari.org/dev/developers/contribut

### quickstart: local setup
* __Check the prerequisites__
1. Create a [development installation](https://napari.org/dev/developers/contributing/dev_install.html#dev-installation) of `napari` on your local machine.
1. 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`.
1. Create a clean Python environment (e.g., with conda), and with your local clone's root folder as the working directory, install the docs requirements with `python -m pip install -r requirements.txt`.
1. Create a clean Python environment (e.g., with conda).
1. In that environment, create a [development installation](https://napari.org/dev/developers/contributing/dev_install.html#dev-installation) of `napari` on your local machine, first forking and cloning the main `napari` project if you've not previously done so.
1. 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`.
1. 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](https://napari.org/stable/developers/documentation/index.html#building-the-documentation-on-windows).
* From the root of your local clone of this repository, run one of these:
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/contributing/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ cd napari-docs/
Since the API reference documentation (autogenerated from the napari code docstrings) and the example gallery are sourced from the `napari/napari` repository, before you can build the documentation locally, you need:

- a clean `conda` environment;
- a development installation of napari. Follow the [contributor guide](dev-installation) for details on how to do this;
- a development installation of napari in that environment. Follow the [contributor guide](dev-installation) for details on how to do this;
- the napari documentation requirements. Starting at the folder where you cloned the `napari/docs` repository, and after activating your clean `conda` environment, you can install these with `python -m pip install -r requirements.txt`.

This setup, with these dependencies, will allow you to preview your document locally as it would appear on `napari.org`. It will also install [Jupyter notebook](https://jupyter.org/) and [jupytext](https://jupytext.readthedocs.io), which you will need to contribute documents containing code or viewer interactions.
Expand Down

0 comments on commit cc35c2a

Please sign in to comment.