Build a tested, sphinx-based website from notebooks
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.
To get started using nbsite, please see Getting Started. However, please note that this is a pre-release version of nbsite. If you use nbsite, you may subsequently have to change your config on upgrading to a newer version of nbsite. You will likely encounter limitations and problems. However, please file issues or ask questions on GitHub.
Many of the websites in the pyviz ecosystem are built using nbsite. These include:
When to use nbsite¶
Nbsite is recommended for users who want to generate a static site from content in notebooks. It is especially useful if those notebooks contain bokeh plots.
When not to use nbsite¶
Nbsite is not recommended if you don’t mind writing rst, don’t have bokeh plots or are primarily interested in live notebooks. There are other projects to consider instead if that is your case:
static site generators with support for notebooks: nikola, pelican, jupytersite, hugo, (whatever seaborn uses), (whatever scikit-learn uses), (wahtever scikit-image uses), …
live notebook hosting: mybinder (example); …?