1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
|
Jupyter Notebook Tools for Sphinx
=================================
``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.
.. _Sphinx: http://sphinx-doc.org/
.. _Jupyter Notebook: http://jupyter.org/
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:
#. Install ``nbsphinx``::
python3 -m pip install nbsphinx --user
#. Edit your ``conf.py`` and add ``'nbsphinx'`` to ``extensions``.
#. Edit your ``index.rst`` and add the names of your ``*.ipynb`` files
to the ``toctree``.
#. Run Sphinx!
|