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.7.tar.gz (73.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsite-0.8.7.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.7.tar.gz
Algorithm Hash digest
SHA256 6d81ad57734e8ad9363ca987e6e12f392edf17bb693eaf9c9601328466194d6b
MD5 0a84e64e81f978ff7be1353ce608d33d
BLAKE2b-256 7844d92b2e5f326a78666f914afb4fa1dc6b2529383d61e8ddf87f2a59eb6496

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsite-0.8.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 83.6 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.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 910a0e4da170a987668fbc0946a60fb635ddff7fbb7ef0c9fb53e21532e779a1
MD5 66d5ad34abdc8de4d6c14d6f0904faa2
BLAKE2b-256 0be207e9ef2b82cdb7baf5265a318c81a027b70e2fb0053657e342dcaaf8e40c

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