Skip to content

napari/napari-sphinx-theme

Repository files navigation

napari-sphinx-theme

A Sphinx theme based on the awesome pydata-sphinx-theme with the look and feel of napari.

This is currently a work-in-progress, but since it extends the pydata-sphinx-theme, all the existing configurations and affordances are already available. Check out the PyData Docs for more info.

Installing for development

After creating a virtual environment, install the theme in editable mode:

python -m pip install -e .

Building a demo site

To build the demo site, run:

cd docs/
make html

Using it to build the napari website

To build the napari website, install the theme as a dependency.