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

Uploaded Source

Built Distribution

nbsphinx-0.4.3-py2.py3-none-any.whl (20.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.4.3.tar.gz
  • Upload date:
  • Size: 115.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.4+

File hashes

Hashes for nbsphinx-0.4.3.tar.gz
Algorithm Hash digest
SHA256 577a9f26c39fbe0d8eda18940b13661a9b7b4b12c7127bbecdc7edf72b3c4426
MD5 2cd697365f6450f5aed52acb40ed81db
BLAKE2b-256 6878c517adc5015abb54aa4176c2b2667abb702d346a1dc39a018e2b5516508b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.4.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.4+

File hashes

Hashes for nbsphinx-0.4.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c39b8b4d7f3c7b02ba608be3508414c033906d40caa8b6fcfef81c9c8527c47a
MD5 e8456cdc2fc2e80a0c2b5c6497e8966f
BLAKE2b-256 391fc912f2f95d53d818dc76867f950883ae8a92849b7bef12a783106143cf08

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