Documentation پیچیده

ماژول مثال قبل خیلی کوچک بود! اکثر کتابخانه های واقعی شامل راهنماها( guides ) و آموزش های ( tutorials ) مختلفی هستند که این آموزش ها در کنار API documentation عرضه می شود مثلا داکیومنت های Django, FastAPI یا CPython را بررسی کنید تا متوجه مسئله بشوید. این داکیومنتیشن ها همگی با Sphinx تولید شده اند!

یکی از علل اصلی موفقیت یک پکیج داکیومنتیشن خوب و مناسب آن است. هرچقدر بیشتر در بکارگیری پکیج خود به دیگر توسعه دهنده ها کمک کنید و با داکیومنتیشن خوب راهگشای مشکلات باشید، از پکیج شما بیشتر استقبال می شود.

در کنار این ابزار دیگری نیز وجود دارند که میتوانند تولید و توزیع (delivery ) داکیومنتیشن های پکیج های شما را به صورت خودکار انجام دهند. معروف ترین این ابزار readthedocs است که یک رابط کاربری ساده و بی نظیر دارد و برای داکیومنتیشن ما نیز یک آدرس تحت وب تولید می کند.

اگر از readthedocs استفاده کنیم، زمانی که شاخه( branch ) master یا main پروژه ی پکیج ما بروز شود، به صورت خودکار داکیومنت جدیدی تولید می شود.

نکته:

برای ساخت اکانت readthedocs میتوانید به آدرس زیر بروید و بعد از ایجاد اکانت، ریپازیتوری های گیتهاب خود را به آن وصل کنید و فرآیند CD( Continuous delivery ) داکیومنتشن های خود را به صورت خودکار انجام دهید:

https://about.readthedocs.com/?ref=readthedocs.org

حالا برنچ(branch ) یعنی چه؟ در ادامه ی این فصل به مفهوم Version Control و Source Management می پردازیم!