19 lines
637 B
Plaintext
19 lines
637 B
Plaintext
|
Algo Fun Doc
|
|||
|
|
==============
|
|||
|
|
|
|||
|
|
|
|||
|
|
- install sphinx
|
|||
|
|
|
|||
|
|
- install the nbsphinx extension
|
|||
|
|
|
|||
|
|
|
|||
|
|
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.
|
|||
|
|
|
|||
|
|
Quick Start::
|
|||
|
|
|
|||
|
|
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!
|