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:

http://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 with pip:

    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 (without the .ipynb extension) to the toctree directive.

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

Uploaded Source

Built Distribution

nbsphinx-0.2.1-py2.py3-none-any.whl (25.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for nbsphinx-0.2.1.tar.gz
Algorithm Hash digest
SHA256 93f681a312e7095b5a030da26207c7b299352a410cd7f0797dfa1bbc991f00c0
MD5 e9dcb2e5b8e3144533ce291c2f97dfc2
BLAKE2b-256 3d7caee5776ef26371428bdda1e88d0c39ef11a2bcaae0ab9a8e464e67e4ce55

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nbsphinx-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d014e4a0fcbc51625d93dddb07a279f889cbe9b8628ffae822b77d92192914f3
MD5 d91a483b81cea9377f0aa368eb2cd1e2
BLAKE2b-256 f7c0df12faf201c92f54e8baec27a88510cb1209d8132d125074ac4da9d6e4be

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