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-hypernode.com/pypi/nbsphinx/

License:

MIT – see the file LICENSE for details.

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!

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

Uploaded Source

Built Distribution

nbsphinx-0.2.15-py2.py3-none-any.whl (16.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.15.tar.gz
Algorithm Hash digest
SHA256 2c1d0b9e89f6b03a1420507938972a14e0dc06bd3cd398a94ccf33c2fe8745d2
MD5 d7e07de6640bdd0ea0108cbaf5e63c93
BLAKE2b-256 aa2f4f9a91477037a731bc67f493fb747f03e5b22ead43dfd7e6e85c40bf3354

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.15-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cc01fb677a287eb30cca5a197729a632db4bbda3a401d1c465bf2f7bef477c82
MD5 fac1b3ffcf54a9fb59121234cbbbca1d
BLAKE2b-256 5b1126f44a7001e705cd5c5770fa11e2bbc68779820072235c8eee21b53dcdaf

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