Le format reStructuredText ou le formatage à portée de tous

Magazine
Marque
SysOps Pratique
Numéro
80
Mois de parution
novembre 2013
Spécialité(s)


Résumé
Le format reStructuredText est un langage de balisage léger, c'est-à-dire un langage permettant de structurer du texte dont le code source reste très lisible, y compris pour des non-informaticiens.

1. Présentation

Le format reStructuredText (souvent abrégé en reST ou ReST, ou encore RST, à ne pas confondre avec REST) est une évolution du format StructuredText développé par Zope et de Setext qui a pris son essor dès 2002, il y a donc plus de 10 ans. Aujourd'hui, il s'agit d'un format de référence.

Il est en effet au cœur de Sphinx, le générateur de documentation de référence du langage Python et l'implémentation de référence de son parseur est celle de Docutils. Autant dire qu'il est aujourd'hui très utilisé pour la documentation de Python, mais pas seulement, puisqu'il l'est aussi dans Trac, par exemple, mais plus généralement par d'autres projets dont Python n'est pas le langage de programmation.

La première partie de l'article va proposer un tour d'horizon de ce qu'il est possible de faire avec ce format, puis on verra comment générer un document ainsi qu'une présentation à partir d'un code source reST.

2. Le format reST

2.1 Emphases et…

Cet article est réservé aux abonnés. Il vous reste 93% à découvrir.
S'abonner à Connect
  • Accédez à tous les contenus de Connect en illimité
  • Découvrez des listes de lecture et des contenus Premium
  • Consultez les nouveaux articles en avant-première
Je m'abonne


Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous