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

Uploaded Source

Built Distribution

nbsphinx-0.3.2-py2.py3-none-any.whl (17.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.3.2.tar.gz
Algorithm Hash digest
SHA256 662530728b66bed43ddd82d51ac2ef4ad01d04baf63b4e2fc5c360f6fc0bdf63
MD5 ab60257082c18c5ddbc4c479ae57a9b9
BLAKE2b-256 457f36868c530ef7fb219f6fa86a3765f49b748937e318de6fd35e9ddbe5c8f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9527a525f588a7421f0078e606489a1da4c97ef6e13ca227f7174518c0aa17cf
MD5 5b549a9de1aeabdab9b6e28583ea39f6
BLAKE2b-256 47f0b5e0e7345d467c21fd910942343f509c12923605f541006c3682ed06c116

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page