RST Validator

Der RST Validator analysiert reStructuredText-Quellen, um Syntaxfehler, falsches Verschachteln, gebrochene Referenzen und den Missbrauch von Direktiven zu erkennen. Er richtet sich an Entwickler, technischer Redakteure und Teams, die auf Python-Tools, Sphinx oder CI-Pipelines angewiesen sind, um saubere, robuste Dokumentation über mehrere Repositorien und Sprachen hinweg zu erstellen.
Konzeptuell nutzt das Tool einen Parser auf Basis von Docutils, um einen standardisierten AST zu erstellen, dann wendet es ein konfigurierbares Regelwerk an, um Probleme von fehlenden Rollen und undurchsichtigen Substitutionen bis hin zu ungültigen Cross-Referenzen zu identifizieren. Es berichtet jedes Problem mit Zeilennummern, Schweregrad und umsetzbaren Hinweisen.
Der einzigartige Wert liegt in dem leichten, automationsfreundlichen Design: Es kann lokal oder in CI laufen, maschinenlesbare Ergebnisse ausgeben und projektspezifische Konventionen durch optionale Lint-Regeln erzwingen. Es konzentriert sich auf Struktur statt Rendering, was es ideal für Pre-Commit-Prüfungen und frühe Reviews macht.
Kernfunktionen umfassen Syntaxvalidierung, Referenz- und Direktivenprüfungen, konfigurierbare Regel-Pakete, UTF-8-Unterstützung und Outputs, die für die Automatisierung geeignet sind. Typische Anwendungsfälle umfassen das Validieren von RST-Dokumenten vor Veröffentlichungen, während Builds oder in Code-Reviews, um Hin- und Her-Lesen zu reduzieren.