Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally written for the Python documentation, but has since become a tool for creating documentation for arbitrary projects. It uses reStructured Text (an easy-to-read plain-text format) and can convert the plain-text sources into a variety of formats, including HTML, LaTeX and manual pages.

User instructions

Sphinx 1.4.9 is installed on all workstations from the Debian repositories.

Extensive documentation is available at the Sphinx website. There’s also a nice tutorial written by the matplotlib developers.



Admin notes

The version from the Debian repositories is sufficiently recent currently.