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.rtfd.org/

Code:

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:

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

Uploaded Source

Built Distribution

nbsphinx-0.2.6-py2.py3-none-any.whl (12.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.6.tar.gz
Algorithm Hash digest
SHA256 a99cc0ef4c6245a9ff69a777ab6492cf008de9a34e3f7a05480a38ecb599fd5c
MD5 3ab677821d08834964a9dc6061c718ce
BLAKE2b-256 7f84ebc6da08a74c9e76964faf705d29706c12f69a8a1966bc226de678bd9c83

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 92410498d635176813a35fc6e296f553c519f61c69aed622d3c5ee11fb31f9d1
MD5 d1d214ca7ed463314efbd6ed93698505
BLAKE2b-256 f60071f06f69534591a4c8ba089e8189d95c07777599cc015ab837fae8063e6b

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