Skip to main content

Jupyter Notebook Tools for Sphinx

Project description

nbsphinx is a Sphinx extension that provides a source parser for *.ipynb files. Custom Sphinx directives are used to show Jupyter Notebook code cells (and of course their results) in both HTML and LaTeX output. Un-evaluated notebooks – i.e. notebooks without stored output cells – will be automatically executed during the Sphinx build process.

Quick Start:
  1. Install nbsphinx

  2. Edit your conf.py and add 'nbsphinx' to extensions.

  3. Edit your index.rst and add the names of your *.ipynb files to the toctree.

  4. Run Sphinx!

Online documentation (and example of use):

https://nbsphinx.readthedocs.io/

Source code repository (and issue tracker):

https://github.com/spatialaudio/nbsphinx/

License:

MIT – see the file LICENSE for details.

Project details


Download files

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

Source Distribution

nbsphinx-0.9.7.tar.gz (180.5 kB view details)

Uploaded Source

Built Distribution

nbsphinx-0.9.7-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file nbsphinx-0.9.7.tar.gz.

File metadata

  • Download URL: nbsphinx-0.9.7.tar.gz
  • Upload date:
  • Size: 180.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nbsphinx-0.9.7.tar.gz
Algorithm Hash digest
SHA256 abd298a686d55fa894ef697c51d44f24e53aa312dadae38e82920f250a5456fe
MD5 e5a213e3816fd852793988d7414c755b
BLAKE2b-256 1e84b1856b7651ac34e965aa567a158714c7f3bd42a1b1ce76bf423ffb99872c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsphinx-0.9.7.tar.gz:

Publisher: publish.yml on spatialaudio/nbsphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nbsphinx-0.9.7-py3-none-any.whl.

File metadata

  • Download URL: nbsphinx-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 31.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nbsphinx-0.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7292c3767fea29e405c60743eee5393682a83982ab202ff98f5eb2db02629da8
MD5 80f23c3e9e6cb2afab731b9ea6c9f2b5
BLAKE2b-256 492d8c8e635bcc6757573d311bb3c5445426382f280da32b8cd6d82d501ef4a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for nbsphinx-0.9.7-py3-none-any.whl:

Publisher: publish.yml on spatialaudio/nbsphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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