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.

Documentation (and example of use):

http://nbsphinx.readthedocs.io/

Source code repository (and issue tracker):

https://github.com/spatialaudio/nbsphinx/

Python Package Index:

https://pypi.python.org/pypi/nbsphinx/

License:

MIT – see the file LICENSE for details.

Quick Start:
  1. Install nbsphinx:

    python3 -m pip install nbsphinx --user
  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!

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbsphinx-0.2.14-py2.py3-none-any.whl (16.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.14.tar.gz
Algorithm Hash digest
SHA256 d6a35b62be88eadaec8b9e5d61916012b9e26b16f4895ab0bbc5ee1e99fbbee0
MD5 991fc5f31ee09165e364739f2016371b
BLAKE2b-256 6e974dd4ca65a9abd2b75c82df3b7dfeb846731e9c50cd504f2e8674e29263e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0a53abe32b22be5bd5c8e5e603e128e6a628e41a7ed7d69302a5fab5169739d7
MD5 9cd40f50c08f14c9a4bf76a1377dd6a6
BLAKE2b-256 b0e00d1d70899497a414d05f35dafeb9bbb7e8a6a744d1ede4140004e58b153c

See more details on using hashes here.

Supported by

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