RST Validator

Le Validateur RST analyse les sources reStructuredText pour détecter les erreurs de syntaxe, un nesting incorrect, des références rompues et un usage incorrect des directives. Il cible les développeurs, les rédacteurs techniques et les équipes qui s'appuient sur les outils Python, Sphinx ou les pipelines CI pour produire une documentation propre et durable à travers plusieurs dépôts et langues.
Sur le plan conceptuel, l'outil utilise un analyseur basé sur docutils pour construire un AST standard, puis applique un ensemble de règles configurables pour identifier les problèmes tels que les rôles manquants et les substitutions obscures jusqu'aux références croisées invalides. Il signale chaque problème avec les numéros de ligne, la gravité et des conseils actionnables.
Sa valeur unique réside dans son design léger et automatisable: il peut s'exécuter localement ou en CI, produire des résultats lisibles par machine et faire respecter les conventions de projet via des règles de lint optionnelles. Il se concentre sur la structure plutôt que l'affichage, ce qui le rend idéal pour des vérifications pre-commit et des revues précoces.
Les fonctionnalités clés incluent la validation de syntaxe, les vérifications de références et de directives, des packs de règles configurables, la prise en charge UTF-8 et des sorties adaptées à l'automatisation. Des cas d'utilisation typiques incluent la validation des documents RST avant les versions, pendant les builds ou lors des revues de code pour réduire les allers-retours.