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

Uploaded Source

Built Distribution

nbsphinx-0.4.2-py2.py3-none-any.whl (20.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.4.2.tar.gz
  • Upload date:
  • Size: 109.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for nbsphinx-0.4.2.tar.gz
Algorithm Hash digest
SHA256 b794219e465b3aab500b800884ff40fd152bb19d8b6f87580de1f3a07170aef8
MD5 6a5c99621f319f61e856b121c1b9afe0
BLAKE2b-256 bd78bea43a90c3b363587df4e0554081f39a43a45014641356dcbab44c079d29

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c39176496b17e34c7a53b13350468ea7d5e076997efbeedd52352a340ade4d3b
MD5 a274bfb4667a244eea8ec9f1dc72a5ad
BLAKE2b-256 780d521a6bda0f7cf5b5129a543fd857238bf792d9b29f2d420d6e63490f9837

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