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

Uploaded Source

Built Distribution

nbsphinx-0.9.5-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.9.5.tar.gz
  • Upload date:
  • Size: 179.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for nbsphinx-0.9.5.tar.gz
Algorithm Hash digest
SHA256 736916e7b0dab28fc904f4a9ae3b53a9a50c29fccc6329c052fcc7485abcf2b7
MD5 c1c36373c79893608ee818191e64afc1
BLAKE2b-256 af49a6b1ed510bcc7734daa20372222804d6109d3087ced82f65c8720da90ef4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for nbsphinx-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d82f71084425db1f48e72515f15c25b4de8652ceaab513ee462ac05f1b8eae0a
MD5 e6d680fb94e1afa67fedcd49b1af84bf
BLAKE2b-256 ae8a5a1e56efa95e2038de5646e2bc5c0abe18678ae5d167e267c0fbaa17a372

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