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):
- Code:
- Python Package Index:
- License:
MIT – see the file LICENSE for details.
- Quick Start:
Install nbsphinx with pip:
pip install nbsphinx --user
… or, if you prefer, just copy the file nbsphinx.py your Sphinx directory.
Edit your conf.py and add 'nbsphinx' to extensions.
Edit your index.rst and add the names of your *.ipynb files (without the .ipynb extension) to the toctree directive.
Run Sphinx!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nbsphinx-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aac9e68fbb0e25c541a677867b461ddc2491b976686b3b62b015148237410474 |
|
MD5 | c9e5aa7eb1404d852ae28b0b072a83e8 |
|
BLAKE2b-256 | fc8fc82e48250e980357873c8bc194717dff5f7064a5e72ddd8d78fa899c4c56 |