در ماژولهایی که تولید میکنیم، از ساختارهایی که توسط تیم OCA ارائه شده، استفاده میکنیم. یکی از کارهایی که در این ساختار در نظر گرفته شده، تولید فایل README بهصورت خودکار است. در حال حاضر برای تولید این فایل از یک الگوی خاص استفاده میشود. ما چطور میتوانیم این الگو را با یک الگوی دلخواه جایگزین کنیم؟
2 پاسخ ها
در ماژولهای OCA، تولید فایل README به صورت خودکار با استفاده از ابزار `maintainer-tools` انجام میشود. یکی از دستورات کلیدی این ابزار، دستور `oca-gen-addon-readme` است که برای تولید فایل README کاربرد دارد. این دستور به صورت خودکار اطلاعات مورد نیاز را از داخل ماژول جمعآوری میکند و فایل README را طبق الگوی پیشفرض تولید مینماید. شما میتوانید از همین ابزار برای نگهداری و توسعه ماژولهای خود نیز استفاده کنید.
دستور `oca-gen-addon-readme` بهصورت پیشفرض از یک فایل تمپلیت به نام `gen_addon_readme.rst.jinja` برای تولید فایل README استفاده میکند. روال کلی به این صورت است که دادههای مورد نیاز از پروژه و ماژول جمعآوری میشود و سپس با استفاده از این فایل تمپلیت، یک فایل README جدید ایجاد میشود. این ابزار با ترکیب اطلاعات جمعآوری شده و الگوی موجود، خروجی نهایی را به صورت اتوماتیک و هماهنگ با ساختار ماژول تولید میکند.
کاری که شما باید انجام بدید این هست که یک الگوی جدید ایجاد کنید و با استفاده از پارامتر خط فرمان به نام --template-filename تعیین کنید. به این ترتیب الگوی شما در تولید این فایل استفاده میشود.
من دنبال راهی هستم که با استفاده از ابزارهای موجود روشی برای تولدی الگوی بهتر داشته باشم. شوربختانه راهکاری که oca داره تولید فایل RST و در نهایت تبدیل اون به HTML است. ما دنبال راهی هستیم که صفحه توضیحات ایجاد شده کمی از نظر گرافیکی ارتقا پیدا کنه. با مکانیزم موجود این کار دشوار هست.