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

Uploaded Source

Built Distribution

nbsphinx-0.7.1-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.7.1.tar.gz
  • Upload date:
  • Size: 129.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.3

File hashes

Hashes for nbsphinx-0.7.1.tar.gz
Algorithm Hash digest
SHA256 f50bd750e4ee3a4e4c3cf571155eab413dc87d581c1380021e7623205b5fa648
MD5 d3f31c1f1f052dada3181203393dc391
BLAKE2b-256 78b102aeb1c0acfdcd8252afedf74168a3e41d8c6708f9b836cc59552b41d0c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.3

File hashes

Hashes for nbsphinx-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 560b23ff8468643b49e19293c154c93c6ee7090786922731e1c391bd566aac86
MD5 f3cdc61ac8b078e23d059cbe8511c991
BLAKE2b-256 4e2dd26ca09ca7659e5bf6fa3334a5417ea3ed871b277ad6efeb6a38b8ac30a1

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