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.

Documentation (and example of use):

http://nbsphinx.rtfd.org/

Code:

http://github.com/spatialaudio/nbsphinx/

Python Package Index:

https://pypi-hypernode.com/pypi/nbsphinx/

License:

MIT – see the file LICENSE for details.

Quick Start:
  1. Install nbsphinx with pip:

    pip install nbsphinx --user
  2. Edit your conf.py and add 'nbsphinx' to extensions.

  3. Edit your index.rst and add the names of your *.ipynb files (without the .ipynb extension) to the toctree directive.

  4. Run Sphinx!

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

Uploaded Source

Built Distribution

nbsphinx-0.2.3-py2.py3-none-any.whl (30.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.3.tar.gz
Algorithm Hash digest
SHA256 ea3d2ee8f8b9d72247dd59a302c0096cfef9313ae2f35881f96be0a543e16fee
MD5 e6dde171547187850ee7d5b328c1f1e2
BLAKE2b-256 6ee9486383e248d77cc31fd8263a997a13651f70086d2c56b1027059eeb56502

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a5c9387a6222393e991ddc2ba204fbd2a65b785e20ac0bfb1e58f34aed806f20
MD5 37ef6a3ee9a5b909b4e28c0dcd83717b
BLAKE2b-256 5ae1a81d678a18ddb6e1571c9155c7160bd3bcba1ee12d9605a1cf942972880b

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