Skip to content
Build a tested, sphinx-based website from notebooks
Branch: master
Clone or download

README.md



NBSite: Build a tested, sphinx-based website from notebooks

Build Status Linux/MacOS Build Status Windows Build status
Coverage codecov
Latest dev release Github tag
Latest release Github release PyPI version nbsite version conda-forge version defaults version
Docs gh-pages site

What is it?

NBSite lets you build a website from a set of notebooks plus a minimal amount of config. Sites built with nbsite include pyviz.org, datashader.org, and hvplot.pyviz.org.

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.

This project is currently an early work in progress. See the documentation at nbsite.pyviz.org for more information.

About PyViz

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

You can’t perform that action at this time.