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

Uploaded Source

Built Distribution

nbsphinx-0.3.3-py2.py3-none-any.whl (17.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.3.3.tar.gz
  • Upload date:
  • Size: 100.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nbsphinx-0.3.3.tar.gz
Algorithm Hash digest
SHA256 5635f04cdb74376f33423813cdaabe5208ef5e6462031843fef7584b821a54a1
MD5 39d75aad990ab6e644f2c08bbd7ecee9
BLAKE2b-256 c0345b7513d9dc62e4827fdfc3407d68b95d265dcca5b1033d50f73dc33c3887

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 efc03285a49554e3f0246ad0b6aa37d59b03777f031a8ed786617a4f594691d0
MD5 2629b848ef42dd1767183577dd2af436
BLAKE2b-256 33afa942fafaa29ff283465ad4cdae5a1d12198c0dddd1d5eb159bbf55702a2b

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