[IPython-dev] SiteMap and Indexes for nbviewer

Doug Blank doug.blank at gmail.com
Sat Apr 19 08:30:54 EDT 2014


On Sat, Apr 19, 2014 at 8:15 AM, Matthias BUSSONNIER <
bussonniermatthias at gmail.com> wrote:

> Hi Doug,
>
> nbviewer is gihutb enabled and allow you to browse folder :
>
> http://nbviewer.ipython.org/github/ipython/ipython/tree/master/examples/
>
> One could had the same for bitbucket i suppose
>

Thanks, I did not know that! Yes, so it looks like that interface does
similar things (I like the breadcrumbs running across the top). Our code
will still be useful if you want a "site map" listing all notebooks, if one
wanted to customize the indexes (ignore certain items from showing), or if
you aren't in github.

-Doug


>
> --
> Matthias
>
>
>
>
>
>
> Le 19 avr. 2014 à 12:08, Doug Blank a écrit :
>
> > 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
> > _______________________________________________
> > IPython-dev mailing list
> > IPython-dev at scipy.org
> > http://mail.scipy.org/mailman/listinfo/ipython-dev
>
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20140419/dda9e39e/attachment.html>


More information about the IPython-dev mailing list