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.readthedocs.io/

Source code repository (and issue tracker):

https://github.com/spatialaudio/nbsphinx/

Python Package Index:

https://pypi.python.org/pypi/nbsphinx/

License:

MIT – see the file LICENSE for details.

Quick Start:
  1. Install nbsphinx:

    python3 -m 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 to the toctree.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsphinx-0.2.10-py2.py3-none-any.whl (15.3 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.10.tar.gz
Algorithm Hash digest
SHA256 2cf73765392613fd8235af519f1a86d42d134b5d918a000822788fd0d5ec694d
MD5 489482b1254593a4273b2ab4585189fa
BLAKE2b-256 5fefee482bff9bb00d25508fe8b1f013b0a19e487497e9325e71a1f6597b9641

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3be3013870421b5efabf3d9fee020ac9e2faceec97ddbce28fd5cddb05739987
MD5 482bab1c68cdaf50abba7a3df7be7bd2
BLAKE2b-256 0ed80194f158ed8d8102e92eec854373c2cbc793644663bebef68092982d0da6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page