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

This version

0.8.2

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.2.tar.gz (62.2 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.2-py2.py3-none-any.whl (71.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: nbsite-0.8.2.tar.gz
  • Upload date:
  • Size: 62.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for nbsite-0.8.2.tar.gz
Algorithm Hash digest
SHA256 f01b883367bf1e12a86bcd3fca36bc497f7c4b44d43a94ebb623b90572b0988e
MD5 fca970df1fb48b716d1ab80675437f77
BLAKE2b-256 8c273f277192ad8cac0c9c3fe57a435cc53ea7a060e2be9c026878412bbaf980

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for nbsite-0.8.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 383080f8a1ae3fef0d4508981f1f5062c64c7f0944fdfc141b38fa8868459135
MD5 33ad8a90e66e49f0c1996d1826669faf
BLAKE2b-256 43cf4590ddf7b7ad2602750c9af03790a74fbf061db627be9300324c3b34be71

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