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

Magazine
Marque
Linux 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.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Les bizarreries de l’isolation des IPC

Magazine
Marque
GNU/Linux Magazine
Numéro
250
Mois de parution
juillet 2021
Spécialités
Résumé

Le namespace IPC (Inter-Process Communication) isole les mécanismes de communication interprocessus (sémaphores, mémoire partagée et queues de messages) hérités d’UNIX Système V et bizarrement, seulement une partie de leurs pendants POSIX.

Des bots pour Discord

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
115
Mois de parution
juillet 2021
Spécialités
Résumé

T'as des bots, mon pote... Elles me bottent. Parfois simples lanceurs de dés ou générateurs de citations de films, les bots peuvent aussi être pensés comme de vrais outils d’automatisation. Qui n’a jamais eu envie de déployer en production avec un simple !deploy dans son outil de discussion d’équipe ? Venez découvrir comment le faire dans cet article !

Godot : tests unitaires et export Android

Magazine
Marque
GNU/Linux Magazine
Numéro
250
Mois de parution
juillet 2021
Spécialités
Résumé

Dans cette série d’articles [1] [2], nous avons découvert comment créer un jeu aussi complexe qu’un jeu d’aventure avec le moteur de jeu Godot. Dans cette dernière partie, nous verrons la finalisation du jeu : menu, tests et export.

Cotation automatique d’un questionnaire manuscrit

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
115
Mois de parution
juillet 2021
Spécialités
Résumé

Suivant le public visé, l’acquisition de données peut encore se faire via un support papier pour des raisons de commodité. Le problème avec le papier, c’est que l’on peut difficilement automatiser l’analyse des données ! À moins que l’on ne se penche sur une solution mettant en œuvre la reconnaissance de symboles...

Python : comment utiliser les context managers ?

Magazine
Marque
GNU/Linux Magazine
Numéro
250
Mois de parution
juillet 2021
Spécialités
Résumé

Vous les utilisez peut être sans le savoir, ou distraitement : les context managers sont mis en œuvre grâce à la syntaxe with ... as. Ils sont peu utilisés en tant que mécanisme à part entière, mais peuvent avoir un grand intérêt dans l’architecture d’un code. Cet article va vous les présenter et vous expliquer comment les utiliser.