The goal of this mission doctorale was to create a software tool that integrates example files in a on-line documentation: Sphinx-gallery.

Starting from simple Python files, the resulting tool runs them, captures the output, figures and text, generates HTML rendering that weave these together, creates IPython notebooks out of them, and exposes all the examples in a gallery. Finally, links are adding the HTML code listing to relate each symbol to the corresponding documentation, leveraging the intersphinx mechanism.

Sphinx-gallery is now used in a variety of projects, such as scikit-learn, MNE-Python, nilearn, or pystruct.

Comments are closed.