Rédaction de documentation au format texte ET html

Le format reStructuredText donne la possibilité de rédiger une documentation très lisible en mode texte, à partir de laquelle une page web statique peut être générée.

C’est en quelque sorte un wiki, mais qui ne nécessite pas de faire tourner un serveur web. Ce langage est utilisé par DocUtils (générateur de documentation) et Sphynx (générateur de documentation python)

Des exemples sur http://docutils.sourceforge.net/docs/user/rst/quickstart.html

Et pour générer une page html à partir du fichier texte :

~$ rst2html fichier_texte.txt > fichier_html.html

Le même format permet aussi de générer des présentations avec des effets plutôt simples, mais impressionnants. Voir la démo d’hovercraft.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *