The napari.org website features a custom theme to support a consistent look-and-feel with the napari hub, however, the current process for building the napari.org site is too complex for documentation contributors to easily preview their changes locally. To simplify the build process, we are going to release the napari.org theme as a pip-installable sphinx theme and rely on the sphinx build process to render the napari.org website.
Intended outcome
The napari.org docs will be refactored to have a more conventional build process via make docs which works the same locally and in production.
How will it work?
We will implement the current napari.org theme as a pip-installable sphinx theme.
Summary
The napari.org website features a custom theme to support a consistent look-and-feel with the napari hub, however, the current process for building the napari.org site is too complex for documentation contributors to easily preview their changes locally. To simplify the build process, we are going to release the napari.org theme as a pip-installable sphinx theme and rely on the sphinx build process to render the napari.org website.
Intended outcome
The napari.org docs will be refactored to have a more conventional build process via
make docs
which works the same locally and in production.How will it work?
We will implement the current napari.org theme as a pip-installable sphinx theme.
Assets
Tasks