[IPython-dev] Index and public link to our notebook example collection

Brian Granger ellisonbg at gmail.com
Sun Feb 17 23:44:58 EST 2013


Great!  Thanks for doing this, it is a huge step forward to have even
this level of visibility to our notebook examples.  This makes me
think that transitioning to notebook based narrative docs might not be
too bad:

* Start to put narrative notebook docs in a directory hierarchy.
* For each dir in the heirarchy, auto-generate a README.md file in the
same way you have done here.

It is not perfect, but I think it is good enough to get us going in
the right direction.

Question: should our narrative docs be in a separate repo moving forward?



On Sun, Feb 17, 2013 at 8:26 PM, Fernando Perez <fperez.net at gmail.com> wrote:
> Hi folks,
> one thing we've been needing badly is an easy way to link to at least
> our official notebook examples.  I went ahead and committed without
> review an update to the docs and website (I didn't touch any core
> code, it's only a readme and a script in tools/), so now we have a
> real index:
> https://github.com/ipython/ipython/tree/master/examples/notebooks#a-collection-of-notebooks-for-using-ipython-effectively
> This is something we can point anyone to and that has immediately
> accessible links to all our intro notebooks.  I've updated the front
> page with this and an official link to nbviewer, which was long
> overdue.
> In the end we'll want nbviewer to do this automatically, but in the
> meantime it's an ok solution so we have *something* that works for
> direct indexing of our examples.  The script is a quick hack, but I'm
> in a huge rush and can't generalize it now.  We can clean it up later.
> Matthias, get those analytics going :)
> Cheers,
> f
> ps - devs: if you add/remove/rename any notebooks, simply go to the
> examples dir and run
> ../../tools/mknbindex.py
> that will re-generate the index file README.md.  As long as the title
> list doesn't change, there's no need to do this, so it shouldn't be a
> burden.
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev

Brian E. Granger
Cal Poly State University, San Luis Obispo
bgranger at calpoly.edu and ellisonbg at gmail.com

More information about the IPython-dev mailing list