Re: [matplotlib-devel] MEP12: Reorganize example gallery and clean up examples

[Tony Yu <ts...@gm...>]

On Tue, Dec 11, 2012 at 4:15 AM, Phil Elson <pel...@gm...> wrote:

> > I'm not sure if non-core-developers are allowed to post MEPs, but I just
> did
>
> Yes please... The more the merrier!
> Aren't you a core dev anyway Tony? :-) You've certainly contributed some
> really valuable features, and even if you don't have access to "the big
> green button" in my eyes you feedback and input are just as valuable.
>

Thanks :)

<snip>

One thing I was considering doing in my implementation was allowing
> multiple tags for each example by adding some extra module level
> information (in a list called "__tags__" perhaps) rather than focussing on
> a directory structure to provide the tag as the current implementation of
> the gallery does (and as far as I can see, the MEP recommends this too).
>

I think tags would be great, but I don't want to be responsible for
implementing them :). As argued in the MEP, tags would be complementary:
Sections would help users who just want to scan the gallery. Maybe we can
"suggest" that clean ups include tags as a way of preparing for the future?


> In the past I have also worked on a gallery extension which uses the
> docstring of the example to provide a richer explanation of what is going
> on (example:
> http://scitools.org.uk/iris/docs/latest/examples/graphics/COP_1d_plot.html).
> An alternative approach which has worked well for me is the walked through
> examples found in scikits-learn (their website is down, but most of the
> examples are good in that regard) which could be done via an iPython
> notebook for the annotations.


Actually, scikit-image borrowed the scikit-learn gallery extension, and I
ended up tweaking it to provide more control over the output:


http://tonysyu.github.com/mpltools/auto_examples/sphinx/plot_plot2rst.html

I haven't looked too closely at the machinery used to generate the
matplotlib gallery, so I'm not sure how difficult it will be to integrate
something like this.

Best,
-Tony