MkAutoDocs

مستودع وثائق الرمز GPT-3.5

يعرض هذا المستودع استخدام نموذج لغة Openai GPT-3.5 لإنشاء وثائق للرمز تلقائيًا. ثم يتم تحويل الوثائق التي تم إنشاؤها إلى موقع "DOC كرمز" لسهولة الوصول والمشاركة.

ابدء

لاستخدام هذا المستودع ، ستحتاج إلى الحصول على ما يلي:

• مفتاح Openai API صالح لنموذج اللغة GPT-3.5.
• قاعدة كود تريد إنشاء وثائق ل.

الاستخدام

1. استنساخ أو قم بتنزيل هذا المستودع على جهازك المحلي.
2. قم بإعداد مفتاح Openai API عن طريق إنشاء ملف .env في دليل الجذر وإضافة السطر التالي ، يمكنك إعادة تسمية المثال. env:

 OPENAI_API_KEY=<your-api-key>

1. قم بتثبيت التبعيات المطلوبة ، Python ، ثم بمجرد تثبيتها ، استخدم الأمر التالي:

 cd ./MKAutoDocs/
pip install -r requirements.txt

4. قم بتحرير ملف التكوين للإشارة إلى مستودع الرمز الخاص بك.
   1. docs_path: المسار النسبي إلى مجلد المستند المطلوب (يجب أن يتطابق مع MKDOCs في ملف التكوين).
   2. ROOT_DIR: المسار المطلق أو المسار النسبي إلى دليل جذر المشروع المطلوب.
   3. source_to_document:
      • المسار المطلق أو المسار النسبي إلى المجلدات التي تريد تحليلها وتوثيقها في دليل الجذر الخاص بك.
   4. المتطلبات: قائمة التبعيات Python لتشغيل DOC كموقع رمز.
      • MKDOCS: 1.4.2
      • Pymdown-Extensions: 9.11
   5. تجاهل _folders: قائمة regex من المجلدات/المجلدات الفرعية لتجاهلها. إزالة أي أو كل إذا أردت.
      • .+. git
      • .pytest
      • يشمل
      • ليب
      • البرامج النصية
   6. تجاهل _files: قائمة Regex من الملفات لتجاهلها. إزالة أي أو كل إذا أردت.
      • .*
      • ^(؟! .By $).
   7. use_state: قيمة منطقية ، سيمنع هذا الملفات من إعادة تنظيمها في كل تشغيل. لا تتردد في إيقاف التشغيل إذا كنت ترغب في تحديث المستندات.
5. قم بتشغيل الأمر التالي لإنشاء وثائق للرمز الخاص بك:

 python Auto_Doc.py

سيستخدم هذا نموذج لغة GPT-3.5 لإنشاء وثائق لقاعدة الكود الخاصة بك وإخراج الوثائق التي تم إنشاؤها كملفات Markdown في دليل docs المكونة.

1. قم بتشغيل مولد الموقع الثابت MKDOCs لتحويل الوثائق التي تم إنشاؤها إلى موقع "DOC كرمز".

على سبيل المثال ، لاستخدام MKDOCs ، قم بتشغيل الأمر التالي في دليل الجذر لمعاينة الموقع:

 mkdocs serve

أو استخدم mkdocs ، لإنشاء موقع:

 mkdocs build

سيؤدي ذلك إلى إنشاء موقع ويب ثابت في دليل site ، يمكنك استضافته على خادم أو خدمة مثل صفحات GitHub.

إذا كنت ترغب في استضافة صفحات جيثب. يمكنك إعداد إجراءات github لتلقائي AutoDeploy على مستندك كموقع رمز mkdocs كيفية استخدام أو نشر يدويًا:

 mkdocs gh-deploy

المساهمة

إذا كنت ترغب في المساهمة في هذا المستودع ، فلا تتردد في فتح طلب سحب أو مشكلة. نرحب بأي ردود فعل أو اقتراحات أو تحسينات على الرمز.

رخصة

تم ترخيص هذا المستودع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا. انظر ملف LICENSE لمزيد من المعلومات.