.. index:: Sphinx, numpydoc
.. _Sphinx:

Sphinx
======

Description
-----------

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.  It was originally written for the `Python documentation <http://docs.python.org/>`_, but has since become a tool for creating documentation for arbitrary projects.  It uses `reStructured Text <http://docutils.sourceforge.net/rst.html>`_ (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 <http://sphinx.pocoo.org>`_.  There's also a nice `tutorial <http://matplotlib.sourceforge.net/sampledoc/>`_ written by the matplotlib developers.

Source
------

http://sphinx.pocoo.org/

http://pypi.python.org/pypi/numpydoc

License
-------

BSD.

Admin notes
-----------

The version from the Debian repositories is sufficiently recent currently.