napari tutorials

Source for napari tutorials website

Usage

Building the book

If you'd like to develop on and build the tutorials book, you should:

• Clone this repository
• Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
• (Recommended) Remove the existing tutorials/_build/ directory
• Run jupyter-book build tutorials/

A fully-rendered HTML version of the book will be built in tutorials/_build/html/.

Adding a new tutorial

1. Make a copy of the template-page.ipynb notebook and add your new tutorial content.
2. Add a line to the table of contents _toc.yml to point to your new tutorial.
3. Run jupyter-book build tutorials/ to view your changes locally.
4. Open a pull request to the napari/tutorials repository

Hosting the book

The html version of the book is hosted on the gh-pages branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main.

If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:

• Navigating to your local build; and running,
• ghp-import -n -p -f tutorials/_build/html

This will automatically push your build to the gh-pages branch. More information on this hosting process can be found here.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.