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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsite-0.8.0rc20-py2.py3-none-any.whl (73.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nbsite-0.8.0rc20.tar.gz.

File metadata

  • Download URL: nbsite-0.8.0rc20.tar.gz
  • Upload date:
  • Size: 64.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for nbsite-0.8.0rc20.tar.gz
Algorithm Hash digest
SHA256 1d0189864622686dfee6034aeda54947840b8fb0da6560acd690f305f37d874b
MD5 2a612dd8aa57264728217af66a23b078
BLAKE2b-256 d35a502ef93418bb5e9cacadfc5effd8766757c61f73a627fbe6217cf699e3b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsite-0.8.0rc20-py2.py3-none-any.whl
  • Upload date:
  • Size: 73.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for nbsite-0.8.0rc20-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a40b3039c5d0416d2e78bdc521f7b35d3e5729b4b5067f7c24bbfd20c3c7395c
MD5 024a63ce625583b3074856d4566bfef3
BLAKE2b-256 3c817635f5d1654614a51643da9ea6ec475ce263a2d7c25e5a0961fb94649d06

See more details on using hashes here.

Supported by

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