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

Uploaded Source

Built Distribution

nbsphinx-0.6.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nbsphinx-0.6.0.tar.gz
  • Upload date:
  • Size: 127.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for nbsphinx-0.6.0.tar.gz
Algorithm Hash digest
SHA256 cf44b8675596fea7320f460f676fee26c8b3ee91140f80e41a77a46272af0081
MD5 b5a6fe51a529e153e8e69fe6bda37e9e
BLAKE2b-256 f4aaa6b5c071a27f47d16cfb6d15931d6f3cd371cf74d62217f70fedf23627fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbsphinx-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for nbsphinx-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc8ce94b00622e2d8fff61338c68734bf0d68dec844b70a8317e6fad7e619783
MD5 6f1a70627d23cb6c3fddefd2c9c3fcc7
BLAKE2b-256 76b4c87003ba077c05804de586f590eec82795637465ec51466579c8a17e8a16

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