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

$ 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é :

$ 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.

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

A lire:

• Sphinx
• RestructuredText Quick Reference