RST Validator

מנתח ה-RST Validator מקורות reStructuredText לזיהוי שגיאות תחביר, טביעות nesting שגויות, קישורים שבורים ושימוש לא נכון ב-directives. הוא מכוון למפתחים, כותבי טכני וצוותים הס relying על כלי Python, Sphinx או CI על מנת לייצר תיעוד נקי ועמיד במאגרים רב-שפתיים.
רעיונית, הכלי משתמש בפרסר על בסיס docutils לבנייה של AST תקני ולאחר מכן יישם חבילת כללים הניתנת להגדרה לזיהוי בעיות כמו תפקידי תפקידים חסרים substitution לא ברור ועד להתייחסות חוצת-קישורים לא תקפה. הוא מדווח על כל בעיה עם מספר שורה ונותן הנחיות מעשיות.
הערך הייחודי שלו נובע מעיצוב קליל המתאים לאוטומציה: יכול לרוץ מקומי או ב-CI, להוציא תוצאות הקריאות למכונה ולאכוף נורמות פרויקט באמצעות כללי lint אופציונליים. הוא מתמקד במבנה במקום בהצגה, כך שהוא אידיאלי לבדיקות pre-commit ולסקירות מוקדמות.
תכונות מרכזיות כוללות אימות תחביר, בדיקות קישורים ו-directives, חבילות כללים הניתנות להגדרה, תמיכת UTF-8 ותוצרי אוטומציה. מקרי שימוש טיפוסיים כוללים אימות מסמכי RST לפני שחרורים, במהלך בנייה או בבקורות קוד כדי להפחית חזרות ובילקים.