Utiliser cette documentation
============================

`Sphinx`_ permet de créer de la documentation facilement. C'est dorénavant lui qui est utilisé pour la nouvelle `documentation de Python`_

.. code-block:: bash

   $ sudo easy_install sphinx
   $ svn co https://subversion.makina-corpus.net/zopina/doc/ doc
   $ cd doc/sphinx/content/
   $ mkdir _html
   $ sphinx-build . _html/

Pour voir le résultat dans votre navigateur préféré :

.. code-block:: bash

   $ open _html/index.html

Vous pouvez dès lors ajouter/modifier les fichiers rst.

**Ne pas ajouter _html au svn, la doc est reconstruite directement sur le serveur.**

**Vérifiez bien que votre syntaxe rst est correcte en relançant sphinx et en vérifiant le rendu html avant de commiter.**

.. code-block:: bash

   $ sphinx-build . _html/
   $ open _html/index.html

A lire:

* `Sphinx`_
* `RestructuredText Quick Reference`_

.. _`documentation de Python`: http://docs.python.org/dev/
.. _`Sphinx`: http://sphinx.pocoo.org/
.. _`RestructuredText Quick Reference`: http://docutils.sourceforge.net/docs/user/rst/quickref.html