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

Uploaded Source

Built Distribution

nbsphinx-0.8.9-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.8.9.tar.gz
  • Upload date:
  • Size: 177.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbsphinx-0.8.9.tar.gz
Algorithm Hash digest
SHA256 4ade86b2a41f8f41efd3ea99dae84c3368fe8ba3f837d50c8815ce9424c5994f
MD5 95ba55efc17e4618c2e0b38c3805dda3
BLAKE2b-256 36a8431455c29bf2a5f559bba7f890a640d474f8e3f870cabb57bc08ca9ac5d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nbsphinx-0.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 a7d743762249ee6bac3350a91eb3717a6e1c75f239f2c2a85491f9aca5a63be1
MD5 87b564208e761645ea7bf56486e9ca26
BLAKE2b-256 5bd1e18913402619e2673bd29e8e1dc17e0a5e2f2058e8cb0a82e5f86661ea3e

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