/nbsite

Build a tested, sphinx-based website from notebooks

Primary LanguageJupyter NotebookBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause


NBSite: Build a tested, sphinx-based website from notebooks
Build Status Build Status
Coverage codecov
Latest dev release Github tag dev-site
Latest release Github release PyPI version nbsite version conda-forge version defaults version
Docs gh-pages site

DISCLAIMER

NBSite is a tool supporting the developers of the HoloViz project. As such it is tailored to their use case, workflow, and breaking changes may occur at any time. We suggest that before using NBSite you investigate alternatives such as MyST-NB or nbsphinx. If you select NBSite anyway, we recommend that you pin its version.

NBSite lets you build a website from a set of notebooks plus a minimal amount of config. The idea behind NBSite is that notebooks can simultaneously be documentation (things you want to tell people about), examples (a starting point for people to run and use themselves), and test cases (see nbsmoke).

Sites built with NBSite

Non exhaustive list of sites built with NBSite (as of November 2022):

About HoloViz

NBSite is part of the HoloViz initiative for making Python-based visualization tools work well together. See holoviz.org for related packages that you can use with NBSite and status.holoviz.org for the current status of each HoloViz project.