Le format RST ( reStructuredTex) est un langage de balisage simplifié destiné à documenter facilement du code. Il fait partie intégrante du langage Python (PEP 287 – reStructuredText Docstring Format).
Aussi, il est pratique d'utiliser du RST dans de la docstring d'un module ou d'une classe. Des générateurs de documentation comme SPHINX pourront s'en servir.
Le site github en fait un usage important dans la présentation des projets en mettant en avant le fichier README.rst des projets (exemple ici avec pycobol) .
Le moyen le plus simple pour avoir une idée du rendu est d'installer l'utilitaire Python Restview:
pip install restview
Puis lancer la commande: Restview <mon_fichier.rst>
Un mini serveur web sera lancé.
Le navigateur ouvrira une page html avec votre RST mis en forme.
Les modifications dans le fichier RST seront immédiatement visibles dans le navigateur
Les balises basiques les plus usitées sont:
Le '=' sous toute un texte pour l'afficher comme un titre.
Le '-' sous toute un texte pour l'afficher comme un sous-titre
Le '*' Pour commencer une liste
Aucun commentaire:
Enregistrer un commentaire