diff --git a/Readme.md b/Readme.md index 3f00dee..8c927fc 100644 --- a/Readme.md +++ b/Readme.md @@ -72,3 +72,23 @@ The next steps are described If you use ConFlowGen and decide to publish your results, we would be glad if you mention our work as defined at https://conflowgen.readthedocs.io/en/latest/background.html#presentation-of-conflowgen. + +

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. + +Quick Start: + +1. Install nbsphinx +2. Edit your conf.py and add 'nbsphinx' to extensions. +3. Edit your index.rst and add the names of your *.ipynb files to the toctree. +4. Run Sphinx! + +Online documentation (and example of use): +https://nbsphinx.readthedocs.io/ + +Source code repository (and issue tracker): +https://github.com/spatialaudio/nbsphinx/ + +License: +MIT -- see the file LICENSE for details. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 6590cf2..e56e45d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -151,6 +151,29 @@ nbsphinx_prolog = """ .. raw:: html +
+ This page was generated from + {{ docname|e }}. + Interactive online version: + Binder badge. + Download notebook. + +
+