napari-sphinx-theme
A Sphinx theme with the look and feel of napari based on the awesome pydata-sphinx-theme.
Description
Since the napari-sphinx-theme extends the pydata-sphinx-theme, the configurations and affordances provided by the PyData Sphinx Theme can be used within the napari docs.
Installation
After creating a virtual environment, install the theme in editable mode:
python -m pip install -e . --group dev
For local development with uv, the shortest path is:
uv sync
Theme development
Configuration options
Modify options in theme.conf to customize the pydata-sphinx-theme for napari.
Styling (CSS)
Styling settings and napari's custom CSS is found in the
static/css/napari-sphinx-theme.css file.
The styling of code snippets is configured in napari_sphinx_theme/napari_code_theme.py.
Templates (HTML)
To modify page layouts, modify the html template files in the napari_sphinx_theme
and napari_sphinx_theme/partials directories.
Build demo docs and theme changes
To build the demo site found in this repo, run from the repository root:
uv run make docs
To start a live preview that rebuilds when you edit the docs or theme files, run:
uv run make docs-live
The live server opens a browser automatically and watches both docs/ and
napari_sphinx_theme/. CSS, templates, and theme configuration changes are
displayed automatically without having to restart the live server.
Build a distribution wheel for local testing
To build a wheel locally, run:
uv run make build
Use the demo site to manually test changes to styles and page layouts.
The napari website
The napari website is built using the napari docs repo. The styling of the website is based on this theme. Install this theme as a dependency in the napari docs repo.
To modify the website's styling, minor changes to CSS can be made in the docs repo. More significant changes, such as those that may impact the entire website and docs, should be made here.
4 maintainers
Metadata
4 maintainers
Release files for napari-sphinx-theme 1.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| napari_sphinx_theme-1.1.3.tar.gz | 107.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| napari_sphinx_theme-1.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 139.2 kB
Release files / napari_sphinx_theme-1.1.3.tar.gz
| Download URL | napari_sphinx_theme-1.1.3.tar.gz |
|---|---|
| Size | 107.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4ff01e65c2f604ac86700aabaa10b5ff5ad9eb727ef756f47c355dbe6979336
|
|
BLAKE2b-256 checksum How to use checksums |
3c7d9588cc7360b4af9d2878107a0580604945e867842ec6d7431976f110050d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency logRelease files / napari_sphinx_theme-1.1.3-py3-none-any.whl
| Download URL | napari_sphinx_theme-1.1.3-py3-none-any.whl |
|---|---|
| Size | 32.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
121a161730859b3122f70217da9aace9b463583f31b28909cb29f04f49977785
|
|
BLAKE2b-256 checksum How to use checksums |
ff56bcd94bab716d4843866ec4411331e0665b8d97253be61282ba5a3272dfa5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency log
