example gallery

Andreas Mueller amueller at ais.uni-bonn.de
Sat Oct 8 18:42:20 EDT 2011


Thanks Emmanuell, that's great :)

On 10/09/2011 12:17 AM, Emmanuelle Gouillart wrote:
> 	Hello,
>
> 	I just wanted to bring to your attention that it is now possible
> to include in the documentation python scripts (in doc/examples), that
> are transformed into a rst page (including the code) when the doc is
> built. If the script a) is named `plot_xxx.py` and b) generates a
> matplotlib figure, then an image of the figure is displayed on the
> corresponding documentation page, and a thumbnail of the figure is added
> to the gallery of examples. I think we all love matplotlib's gallery,
> which is very useful to find how to do specific stuff, so I hope our
> gallery might as well help users to find out how to do specific tasks. It
> may be especially useful for someone who doesn't have the right keywords
> for a google/sphinx text search. The code for generating the example
> pages and the gallery was shamelessly taken from the scikit learn
> codebase! (see their gallery on
> http://scikit-learn.sourceforge.net/stable/auto_examples/index.html)
>
> 	So, it might be a good idea to a) write more examples for the
> gallery, and b) when new functions are added to the scikit, write
> systematically such examples for the doc.
>
> 	Cheers,
> 	Emmanuelle
>




More information about the scikit-image mailing list