======
Sphinx
======


Qu'est ce que Sphinx ?
======================

- un outil de génération de documentation

- utilisé pour Python : http://docs.python.org/dev

- basé sur reStructuredTexti (reST)

Le reST
=======

- texte enrichi de balises

Exemple::
    
    Titre
    =====

    Section 1
    :::::::::

    ok, exemple python::
        
        >>> 1 + 1
    
    Section 2
    :::::::::

    section 2

Le reST 
=======

Résultat:

-----
Titre
-----

Section 1
:::::::::

ok, exemple python::
    
    >>> 1 + 1

Section 2
:::::::::

section 2


Installer Sphinx
================

Facile !

::

    $ easy_install docutils Sphinx

Démarrer un projet de documentation
===================================

::

    $ sphinx-quickstart

Django utilise Sphinx
=====================

David..