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.
Install nbsphinx
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!
MIT – see the file LICENSE
for details.
All content shown below – except for the section Normal reStructuredText Files – was generated from Jupyter notebooks.
nbsphinx
Configuration Valuesnbsphinx_allow_errors
nbsphinx_codecell_lexer
nbsphinx_custom_formats
nbsphinx_epilog
nbsphinx_execute
nbsphinx_execute_arguments
nbsphinx_input_prompt
nbsphinx_kernel_name
nbsphinx_output_prompt
nbsphinx_prolog
nbsphinx_prompt_width
nbsphinx_requirejs_options
nbsphinx_requirejs_path
nbsphinx_responsive_width
nbsphinx_timeout
nbsphinx_widgets_options
nbsphinx_widgets_path
sphinx-autobuild
toctree
In A Notebook
There is also An Orphan Notebook (HTML Only), just for the sake of it.