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

Uploaded Source

Built Distribution

nbsphinx-0.3.0-py2.py3-none-any.whl (16.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.3.0.tar.gz
Algorithm Hash digest
SHA256 84132ec5e6148d959486bf19e1c13047f817121fce84a489567f2400dad21206
MD5 f707ae5927152bf9256e74021e58cab6
BLAKE2b-256 7cf6258559eed6c2540cded6c6288c1ed0d7bedb0b987edd28d3c648bbea6e2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 25ff8a127af12f1991f1c6ab104c0bcf5daa02fd5778803738b2718e78efed22
MD5 e1f597cf020f707e47c1c8b248f3960a
BLAKE2b-256 857f0e34771e43a7a9ca9e1d19bed109e47642aeb273411122e08773a175c230

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