در این پست قصد دارم یکی از زبانهای نشانه گذاری (markup) قدرتمند به نام reStructuredText رو معرفی کنم. علت اصلی معرفی، کاربرد این زبان در تهیه مستندات سیمفونی هست. قراره بزودی درگیر یکی از بخشهای سیفونی بشم و به همین دلیل نیاز دارم و با این زبان آشنا بشم. به خاطر همین در تلاشم که دانشهای اکتسابی رو به اشتراک بذارم

نشان reStructuredText

خب حالا ببینیم که reStructuredText چیست؟

reStructuredText یک پارسر و زبان نشانه‌های ساده برای خواندن و wysiwyg در فایل متن ساده (plain-text) است. این زبان ابزاری قدرتمند برای مستندسازی میان کد در برنامه (مانند Python docstrings) است تا بتوان با کمک آن به سرعت صفحات مستند وبی را ایجاد نمود. این زبان به تنهایی نیز کاربرد دارد. پارسر reStructuredText یکی از اجزای Docutils به حساب می‌آید. در‌واقع reStructuredText نسخه بازبینی شده و جدید زبان نشانه‌های Setext و StructuredText می‌باشد.

هدف اصلی reStructuredText تعریف و پیاده‌سازی نحو (syntax) زبان نشانه‌هایی است که برای استفاده جهت docstrings در زبان قدرتمند پایتون و سایر حوزه‌های مستندسازی، بنا شده است تا در عین سادگی و خوانایی به اندازه کافی قدرتمند باشد. کارکرد زبان نشانه‌ها تبدیل فایل‌های reStructuredText به قالب داده‌هایی ساخت‌یافته است.

نمونه تمام‌عیار یک فایل مستندسازی شده با استفاده از reStructuredText در یک ماشین حالت به زبان پایتون را می‌توانید در این پیوند بیابید: statemachine.py

چهارچوب مورد علاقه من هم (سیمفونی) نیز با همین زبان مستند شده است و تمامی مستندات آنلاین آن نمونه‌های کاملی در استفاده از reStructuredText می‌باشند.

جهت مطالعه بیشتر میتونید به اینجا مراجعه کنید.

تا بعد