<p>Doctutils est une suite d'outils permettant la transformation d'un texte intéligible, grâce à une syntaxe qui lui est propre, en plusieurs formats tels que le HTML ou le LaTeX.</p> <p>La syntaxe utilisée est le reStructuredText que l'on écrit aussi reST.</p> <h2>Installation</h2> <p>Le nom du paquet à installer est python-docutils à adapter en fonction de votre distribution GNU/Linux.</p> <pre># urpmi python-docutils</pre> <h2>Edition</h2> <pre>$ mkdir doc
$ cd doc
</pre> <p>Prenez votre éditeur de prédilection :</p> <pre>$ vim essai.txt

</pre> <hr /><pre>essai de titre
==============


sous-titre
----------

bla bla

- liste 1
- item 2
- item 3

deuxième sous-titre
-------------------

bla bla


::

   ls /tmp
   cd /usr/bin

</pre> <hr /><p>Pour créer un titre, souligner le avec le caractère de votre choix.</p> <p>Pour faire un sous-titre, souligner le avec un autre caractère de votre choix.</p> <p>Pour faire une liste utiliser simplement des tirets.</p> <p>Pour créer un bloc, utiliser :: suivit du contenu avec un retrait.</p> <p><br /> Il est possible d'exporter votre travail vers html, man, odt, pseudoxml, xml, latex et s5.</p> <p>Vim est en mesure d'apporter la coloration syntaxique, pour l'y aider vous pouvez donner l'extension .rst plutôt que .txt.</p> <h2>Exporter</h2> <p>Nous pouvons maintenant exporter notre document dans le format HTML :</p> <pre>$ rst2html essai.txt &gt; essai.html</pre> <p>Vous pouvez maintenant visualiser le résultat dans votre navigateur :</p> <pre>$ firefox essai.html</pre> <p>Voici d'autres balises pour docutils :</p> <p><a>http://docutils.sourceforge.net/sandbox/wilk/french/quickstart-fr.html</a><a href="http://docutils.sourceforge.net/sandbox/wilk/french/quickstart-fr.html"><br /> </a></p> <p>Essayons maintenant avec sphinx. C'est un outil de génération de documentation pour les projet Python.</p> <h2>Installation</h2> <pre># urpmi python-sphinx
</pre> <h2>Liens</h2> <p>Site de docutils :</p> <p><a href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/<br /> </a></p> <p>Le guide de démarrage rapide de rST :</p> <p><a href="http://docutils.sourceforge.net/docs/user/rst/quickref.html">http://docutils.sourceforge.net/docs/user/rst/quickref.html</a></p>