مجسمه ابوالهول-من یک ابزار پایتون است که به یک پوسته اسناد مجسمه ابوالهول برای پروژه خود را ایجاد و شامل فایل README به عنوان شاخص مستندات و nbsp است؛ این دسته استخراج داده های متا مورد نیاز مانند نام پروژه، نویسنده و نسخه از خود را پروژه برای استفاده در اسناد مجسمه ابوالهول شما.
هنگامی که شما با استفاده از مجسمه ابوالهول-من برای ساخت اسناد مجسمه ابوالهول خود را، بعد از آن شما می توانید پروژه خود را به سایت خواندن اسناد اضافه و README پروژه خود را به میزبانی با مجسمه ابوالهول جذاب تم اسناد.
توجه: فایل README شما باید در یک قالب سازگار reStructuredText باشد.
نصب
ساده ترین راه برای نصب مجسمه ابوالهول-من است به طور مستقیم از PyPI با استفاده از پیپ یا setuptools با اجرای دستور زیر مربوطه:
تصویر در تصویر نصب -U مجسمه ابوالهول-من
و یا:
easy_install -U مجسمه ابوالهول-من
در غیر این صورت شما می توانید مجسمه ابوالهول-من دانلود و نصب آن به طور مستقیم از منبع:
پایتون setup.py نصب
در حال اجرا
مجسمه ابوالهول-من به عنوان یک اسکریپت سیستم گسترده است که می تواند از خط فرمان در حالی که در فهرست ریشه پروژه خود را اجرا نصب:
مجسمه ابوالهول-من
هنگامی که در پوشه پروژه خود را اجرا کنید، آن را به یک دایرکتوری اسناد با دو فایل، ماژول conf.py مجسمه ابوالهول و یک فایل index.rst که شامل README پروژه خود را ایجاد خواهد کرد.
ماژول conf.py یک تابع راه اندازی از تماس مجسمه ابوالهول-من که مجموعه تا حداقل تنظیمات مورد نیاز برای اسناد مجسمه ابوالهول شما.
- پروژه - نام پوشه پروژه شما استفاده می شود.
- نسخه - بازیابی شده از ارگ نسخه از اسکریپت setup.py خود، و یا صفت __version__ بسته بندی خود را است.
- کپی رایت - بازیابی شده از ارگ نویسنده اسکریپت setup.py خود، و یا صفت __author__ بسته بندی خود را به
در مورد نیاز:.
پایتون
نظر یافت نشد