[IPython-dev] SiteMap and Indexes for nbviewer

[Doug Blank]

nbviewer is a great utility for showing notebooks. However, when you start
to get a collection of notebooks, it can be difficult to use nbviewer
usefully. To solve this issue, we wrote a couple of Python programs to
create Index.ipynb files for directories, and SiteMap.ipynb to index all of
the notebooks. (We hope that this is in the spirit of what nbviewer was
intended).

Features:

* If you have a README.md in a directory, it will be added as a cell in the
Index.ipynb
* Each Index creates links to subfolders with Index.ipynbfiles  and to
notebooks in the folder
* Allows you to add a header to each page

The code is quite basic at this point, but we'll revise and incorporate new
features and better structure as we develop it.

Here is our SiteMap and toplevel Index:

http://nbviewer.ipython.org/urls/bitbucket.org/ipre/calico/raw/master/notebooks/SiteMap.ipynb

http://nbviewer.ipython.org/urls/bitbucket.org/ipre/calico/raw/master/notebooks/Index.ipynb

The code is here:

https://bitbucket.org/ipre/calico/src/master/notebooks/make.py
https://bitbucket.org/ipre/calico/src/master/notebooks/code2notebook.py

Limitations: currently no links back to top; you have to update the cached
nbviewer version (using url + "?create=1") outside of this code.

Ideas/suggestions welcomed; hope this can be of use,

-Doug
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20140419/ed26c5cf/attachment.html>