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):

http://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.5.0.tar.gz (119.3 kB view details)

Uploaded Source

Built Distribution

nbsphinx-0.5.0-py2.py3-none-any.whl (20.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.5.0.tar.gz
  • Upload date:
  • Size: 119.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.5

File hashes

Hashes for nbsphinx-0.5.0.tar.gz
Algorithm Hash digest
SHA256 16fad6f2a7191972c98df84e76b78f86161f859682e44107668384f916aee00d
MD5 910d32813e63bd27b96dc3be7dd5f84a
BLAKE2b-256 4f5bee04ee0683f3865135768d6af3802a8917621124245156748be69a645591

See more details on using hashes here.

File details

Details for the file nbsphinx-0.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: nbsphinx-0.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.5

File hashes

Hashes for nbsphinx-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2d28bde42b22b66ea8699aa8275547baa524c296ee18d440448b7ab000f96f65
MD5 6168a8699b60b7622f3be6d95e3da2c9
BLAKE2b-256 21ecae7d3e3732a248ad2f75745102eaf4a6e495cc6132c9ab4249d70a268536

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