nbsite0.8.7
Published
Build a tested, sphinx-based website from notebooks.
pip install nbsite
Package Downloads
Authors
Project URLs
Requires Python
>=3.9
Dependencies
- param
>=1.7.0 - pyviz-comms
- ipykernel
- nbformat
- nbconvert
- jupyter-client
- myst-nb
>=1.1 - sphinx-design
- notebook
- sphinx
>=7 - beautifulsoup4
- jinja2
- pillow
- portalocker
- pydata-sphinx-theme
<0.16,>=0.15 - myst-parser
>=3 - sphinx-copybutton
- sphinxext-rediraffe
- setuptools
; extra == "build" - param
>=1.6.1; extra == "build" - selenium
; extra == "gallery" - phantomjs
; extra == "gallery" - graphviz
; extra == "refman" - flake8
; extra == "tests" - pytest
>=3.9.1; extra == "tests" - pre-commit
; extra == "tests"
NBSite: Build a tested, sphinx-based website from notebooks
| Build Status |  |
| Coverage |  |
| Latest dev release |   |
| Latest release |      |
| Docs |   |
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):
- Panel
- hvPlot
- HoloViews
- GeoViews
- Datashader
- Lumen
- Colorcet
- Param
- HoloViz.org
- examples.pyviz.org
- PyViz.org
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.