REST: Un format de document bien util pour l'exploitant système
reST - restructured text - est un format intéressant pour tout exploitant-système qui aime avoir un système de document pour rédiger ses notes dans un simple fichier text.
Généralement quand je dois tester un nouvel outil ou de nouvelles commandes comme tout bon exploitant-système qui se respecte, j'ai toujours mon petit fichier texte ouvert à côté de mon terminal Linux pour y mettre mes notes
Et puis une fois les tests terminés, il faut penser à rédiger la documentation sur ce qu'on a fait.
Là au moins, je me contente juste de retoucher mes notes, à soigner la mise en conformité par rapport au format rest et le tour est joué. D'ailleurs pour les collègues, grâce à rst2pdf une simple conversion et le tour est joué 
rst2pdf est un projet sous google code rst2pdf permettant donc cette fameuse a conversion au format pdf. Le site du projet est http://code.google.com/p/rst2pdf/
Personnellement, en dehors de l'usage que je fais généralement pour dblatex pour des documents plus élaborés, ce format s'avère
- léger notamment pour son utilisation
- util pour garder des commandes habituelles au travail sous la main.
C'est sur le site http://culot.org/public/Docs/documentation_rest.html que j'ai appris un peu à utiliser ce format 
qui propose un exemple pour la conversion au format html: rst2html
INSTALLATION
Il faut commencer par installer les divers paquets attendus
apt-get update
apt-get install -y python-setuptools gcc python2.5-dev
easy_install -U setuptools
Si on veut pouvoir bénéficier de l'ajout d'image dans son fichier, il suffira d'ajouter le paquet
python-imaging
apt-get install python-imaging
Il ne reste plus qu'à télécharger et installer
wget http://rst2pdf.googlecode.com/files/rst2pdf-0.14.2.tar.gz
tar xvzf rst2pdf-0.14.2.tar.gz
cd rst2pdf-0.14.2
python setup.py install
EXEMPLE AU FORMAT REST ET EXEMPLE EN PDF
Dans un simple fichier text exemple.rst, on mettra par exemple le texte suivant et on obtiendra le fichier pdf suivant http://www.davidgis.fr/download/exemple-rst2pdf.pdf
La conversion sera faite simplement en faisant
rst2pdf exemple.rst -o exemple-rst2pdf.pdf
=========================================
Installation de rst2pdf sous Debian Lenny
=========================================
:Author: Jean David TECHER
:Version: 0.1
:Copyright: Ce document est extrait du site http://www.davidgis.fr.
.. sectnum::
.. contents:: Table des matières
------------
introduction
------------
Ce document contient les commandes nécessaires pour la compilation
de rst2pdf sous Debian Lenny.
rst2pdf permet de convertir un fichier au format reST au format pdf
sans avoir à recourir à des convertisseurs à la LaTeX.
Le site du projet est http://code.google.com/p/rst2pdf/
Mise à jour du document: |date|.
--------
Principe
--------
La conversion est illustrée sur l'image suivante
.. figure:: diagrammerst2pdf.png
:scale: 300 %
:align: center
:width: 390px
Principe de conversion
------------
Installation
------------
L'installation concerne:
#. paquets Debian et Python
#. rst2pdf
Paquets Python nécessaires
--------------------------
Sur une Debian fraîchement installée,on effectue
::
apt-get update
apt-get install -y python-setuptools gcc python2.5-dev
easy_install -U setuptools
apt-get install python-imaging
Telechargement et installation
------------------------------
Il suffira de faire
::
wget http://rst2pdf.googlecode.com/files/rst2pdf-0.14.2.tar.gz
tar xvzf rst2pdf-0.14.2.tar.gz
cd rst2pdf-0.14.2
python setup.py install
.. note::
Pour de plus amples renseignements, voir le manuel http://rst2pdf.googlecode.com/svn-history/r52/trunk/manual.pdf ou depuis les sources
il suffit de consulter les exemple fournis dans le répertoire ``rst2pdf-0.14.2/rst2pdf/tests/input``
----------------
.. footer::
Page ###Page###/###Total###
.. |date| date:: %d %b %Y %R
