Skip to main content

Build a tested, sphinx-based website from notebooks.

Project description



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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbsite-0.8.7rc1.tar.gz (73.7 kB view details)

Uploaded Source

Built Distribution

nbsite-0.8.7rc1-py2.py3-none-any.whl (83.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nbsite-0.8.7rc1.tar.gz.

File metadata

  • Download URL: nbsite-0.8.7rc1.tar.gz
  • Upload date:
  • Size: 73.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nbsite-0.8.7rc1.tar.gz
Algorithm Hash digest
SHA256 c290557d8b5d7ef648562a22542c84cea055cd0e47d5b9170b0343110588cd14
MD5 037606ad5107f2e73f3f1c3ef55cd354
BLAKE2b-256 636de5de9a03f2c2d37bd88711a8c135c443bac842dbdba1c35064aefd3e1702

See more details on using hashes here.

File details

Details for the file nbsite-0.8.7rc1-py2.py3-none-any.whl.

File metadata

  • Download URL: nbsite-0.8.7rc1-py2.py3-none-any.whl
  • Upload date:
  • Size: 83.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nbsite-0.8.7rc1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8368044abba9c92cebae69e0305dcb2dc81513fd517109c2a11f2ea235de23ff
MD5 f534b76c6d9d8d6b1569cfe388020d9f
BLAKE2b-256 a5f315b35fb85674abc75a83d7fc616b230a645a422050aa0f5d52f717e7f74b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page