nilearn, scikit-learn, scipy-lectures, and other projects use different variants of a Python script (https://github.com/nilearn/nilearn/blob/master/doc/sphinxext/gen_rst.py) and CSS rules to generate a gallery from their examples (see for instance http://nilearn.github.io/auto_examples/index.html).

The goals of this project are:

1. To add the functionality to generate IPython notebooks alongside with the gallery: For this, the examples would be turned into notebooks that would be hosted on-line:

   • Breaking the examples into cells, using formating added to the example (such as a long line of "#")
   • Generating an IPython1.2-compatible .ipnb (that's an elaborate JSON file)
   • Running this file to have the figures embedded.

2. To establish a separate repository to host this code and avoid redundancy across scikit-learn, nilearn, ...

   • The project should have its repository of its own. It should be easy to embed in the other projects (scikit-learn, nilearn). That latter point is still an open question
   • This repository should run tests in a continuous integration way (using travis), and the Python code should have good test coverage

3. To merge the enhancements and cleanups that have been done in nilearn and scikit-learn to this code

   • There are enhancements to the Python code in scikit-learn (such as test coverage https://github.com/scikit-learn/scikit-learn/pull/3165 ), as well as CSS/HTML cleanup in nilearn.

While goal 1 is the main goal of this project, goals 2 and 3 should be tackled before, as they are necessary to establish the quality assurance of the project.