Source coding :
- Sphinx-gallery: http://sphinx-gallery.readthedocs.org/
- scipy lecture notes: http://www.scipy-lectures.org/
Team leader : Loïc Esteve, Inria, Gaël Varoquaux, Inria, Alexandre Gramfort, Telecom ParisTech
Candidate : NAJERA OCAMPO Oscar
Institutions : Inria, Telecom Paris Tech
Administrator laboratory : UPSud
Engagement : From september 2016 to september 2017
Current status of sphinx-gallery :
Sphinx-gallery 1 is a software tool that integrates example files in a on-line documentation. Starting from simple Python files, it runs them, capturing the output, figures, and text, and generates HTML rendering that combines these, creates IPython notebooks out of them. All the examples are exposed 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 has been created via a previous "project doctoral" of université Paris Sud. It is now used in a variety of projects, such as scikit-learn, MNE-Python, nilearn, or pystruct.
Proposed improvements :
The goal of the new project is to extent sphinx-gallery to a more complete document-generation tool. Indeed, we have found that turning Python script into readable document is useful beyond an example gallery, for instance in the body of the documentation of a software project, or to build course materials to teach numerical methods, algorithmics, or data analysis. For this purpose we will build functions and a command-line utility to turn Python scripts into restructured text, HTML, PDF, and IPython notebooks. These will be tested and improved by integrating in the scipy lecture notes 2 to streamline the build and
the insertion of examples and exercises in the course material.