وأبو الهول لي هو أداة بايثون التي من شأنها خلق وثائق قذيفة أبو الهول لمشروعك ويتضمن الملف التمهيدي حيث أن مؤشر الوثائق على & nbsp؛ وهو يتولى استخراج بيانات التعريف المطلوبة مثل اسم المشروع، والمؤلف ونسخة من حسابك مشروع لاستخدامها في مستندات أبو الهول الخاص بك.
بمجرد استخدام أبو الهول لي لبناء مستندات أبو الهول الخاص بك، ثم يمكنك إضافة المشروع الخاص بك إلى موقع قراءة المشاركات من مستندات ولها README مشروعك استضافت مع مغري أبو الهول موضوع الوثائق.
ملاحظة: يجب أن يكون الملف التمهيدي الخاص بك في تنسيق متوافق reStructuredText.
تركيب
أسهل طريقة لتثبيت أبو الهول لي غير مباشرة من PyPI باستخدام نقطة أو setuptools عن طريق تشغيل الأمر منها أدناه:
PIP تثبيت -U أبو الهول لي
أو:
easy_install -U أبو الهول لي
خلاف ذلك يمكنك تحميل أبو الهول لي وتثبيته مباشرة من المصدر:
بيثون setup.py تثبيت
تشغيل
لي أبو الهول سيتم تثبيت كبرنامج نصي على نطاق المنظومة التي يمكن تشغيلها من سطر الأوامر أثناء وجوده في الدليل الجذر المشروع الخاص بك:
أبو الهول لي
عند تشغيل في دليل المشروع الخاص بك، فإنه سيتم إنشاء دليل مستندات مع اثنين من الملفات، وحدة conf.py أبو الهول، وملف index.rst التي ستشمل README المشروع الخاص بك.
وحدة conf.py تدعو وظيفة الإعداد من أبو الهول لي أن يضع الحد الأدنى الضبط المطلوب للمستندات أبو الهول الخاص بك.
- المشروع - يتم استخدام اسم الدليل من المشروع الخاص بك.
- نسخة - استردادها من ARG نسخة من السيناريو الخاص بك setup.py، أو سمة حزمة الخاص بك __version__.
- حقوق الطبع والنشر - استرجاع من المؤلف وسيطة من السيناريو الخاص بك setup.py، أو سمة حزمة الخاص بك __author__
المتطلبات:.
بيثون
لم يتم العثور على التعليقات