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

Uploaded Source

Built Distribution

nbsphinx-0.8.5-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.8.5.tar.gz
  • Upload date:
  • Size: 145.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for nbsphinx-0.8.5.tar.gz
Algorithm Hash digest
SHA256 c06831d46a768da0b51c3239d45d5a7df2c7e589e5a6d02365cfa49473560ac1
MD5 89041ab77c97d04d56c96aac25c31a31
BLAKE2b-256 ec45feb87ffdd7659d1695463f607c0347560b5f5bdaa28fa18365d2f1956e46

See more details on using hashes here.

File details

Details for the file nbsphinx-0.8.5-py3-none-any.whl.

File metadata

  • Download URL: nbsphinx-0.8.5-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.2

File hashes

Hashes for nbsphinx-0.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5c8a5731d447653b213ba4429c5b5ee55e0a2e92b5bae3ed931d65bc0ce481ed
MD5 27698ef901c79b7fbddeae7a8935f44f
BLAKE2b-256 ed262244da6ce9f323747f2512a7201c54c69bc41e59b624159c7e2c8714e07c

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