Fichier RST

.rst est un format de balisage léger en texte brut utilisé principalement pour la documentation technique dans l'écosystème Python. Les fichiers utilisent une syntaxe lisible par l'homme : les titres de section sont créés en soulignant le texte du titre avec des caractères tels que =, - ou ~ ; les exemples de code sont introduits avec les directives .. code-block:: ; les références croisées utilisent la syntaxe :role: ; et les tables des matières du document sont construites avec les directives .. toctree::.

Comparé au Markdown, le .rst fournit un système formel de directives et de rôles qui permet un balisage sémantique plus riche - notes de bas de page, citations, avertissements personnalisés, références croisées d'API - sans nécessiter d'extensions séparées. Le générateur de documentation Sphinx utilise le .rst comme format source natif et produit la documentation officielle de Python, NumPy, Django et du noyau Linux à partir de fichiers sources .rst.

Les fichiers sont en texte brut UTF-8 sans structure binaire ni « magic bytes », modifiables dans n'importe quel éditeur de texte. Le processeur standard est Docutils, qui convertit le .rst en HTML, LaTeX, PDF et autres formats via des outils en ligne de commande tels que rst2html et rst2latex. Les grands projets Sphinx lient des centaines de fichiers sources .rst individuels via des directives .. toctree::.

Le type MIME couramment utilisé est text/x-rst ; le seul type enregistré par l'IANA, text/prs.fallenstein.rst, n'est pas reconnu par le projet Docutils lui-même. reStructuredText est activement maintenu, bien que les projets plus récents adoptent de plus en plus des alternatives basées sur Markdown comme MyST pour des flux de travail de documentation plus légers.