MkAutoDocs

GPT-3.5 รหัสที่เก็บเอกสาร

ที่เก็บนี้แสดงให้เห็นถึงการใช้รูปแบบภาษา GPT-3.5 ของ OpenAI สำหรับการสร้างเอกสารสำหรับรหัสโดยอัตโนมัติ เอกสารที่สร้างขึ้นจะถูกเปลี่ยนเป็นเว็บไซต์ "Doc As Code" เพื่อการเข้าถึงและการแชร์ได้ง่าย

เริ่มต้น

ในการใช้ที่เก็บนี้คุณจะต้องมีสิ่งต่อไปนี้:

• คีย์ OpenAI API ที่ถูกต้องสำหรับรูปแบบภาษา GPT-3.5
• codebase ที่คุณต้องการสร้างเอกสารสำหรับ

การใช้งาน

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: เส้นทางสัมพัทธ์ไปยังโฟลเดอร์ DOC ที่ต้องการ (ควรตรงกับ MKDOCs ในไฟล์กำหนดค่า)
   2. root_dir: เส้นทางสัมบูรณ์หรือเส้นทางสัมพัทธ์ไปยังไดเรกทอรีรากโครงการที่ต้องการ
   3. source_to_document:
      • เส้นทางที่สมบูรณ์หรือเส้นทางสัมพัทธ์ไปยังโฟลเดอร์ที่คุณต้องการแยกวิเคราะห์และบันทึกไว้ในไดเรกทอรีรากของคุณ
   4. ข้อกำหนด: รายการการพึ่งพา Python เพื่อเรียกใช้เอกสารของคุณเป็นไซต์รหัส
      • mkdocs: 1.4.2
      • pymdown-extensions: 9.11
   5. ignore_folders: รายการ regex ของโฟลเดอร์/โฟลเดอร์ย่อยที่จะละเว้น ลบใด ๆ หรือทั้งหมดหากคุณต้องการ
      • .+. git
      • .pytest
      • รวม
      • lib
      • สคริปต์
   6. ignore_files: รายการ regex ของไฟล์ที่จะละเว้น ลบใด ๆ หรือทั้งหมดหากคุณต้องการ
      • -
      • ^(?! .py $)
   7. use_state: ค่าบูลีนซึ่งจะทำให้ไฟล์ไม่ได้รับการสร้างใหม่ในการรันแต่ละครั้ง อย่าลังเลที่จะปิดหากคุณต้องการอัปเดตเอกสาร
5. เรียกใช้คำสั่งต่อไปนี้เพื่อสร้างเอกสารสำหรับรหัสของคุณ:

 python Auto_Doc.py

สิ่งนี้จะใช้โมเดลภาษา GPT-3.5 เพื่อสร้างเอกสารสำหรับ Codebase ของคุณและส่งออกเอกสารที่สร้างขึ้นเป็นไฟล์ Markdown ในไดเรกทอรี docs ที่กำหนดค่า

1. เรียกใช้เครื่องกำเนิดไซต์คงที่ MKDOCs เพื่อเปลี่ยนเอกสารที่สร้างขึ้นเป็นเว็บไซต์ "DOC AS CODE"

ตัวอย่างเช่นในการใช้ MKDOCs ให้เรียกใช้คำสั่งต่อไปนี้ในไดเรกทอรีรูทเพื่อดูตัวอย่างไซต์:

 mkdocs serve

หรือใช้ mkdocs เพื่อสร้างเว็บไซต์:

 mkdocs build

สิ่งนี้จะสร้างเว็บไซต์คงที่ในไดเรกทอรี site ซึ่งคุณสามารถโฮสต์บนเซิร์ฟเวอร์หรือบริการเช่นหน้า GitHub

หากคุณต้องการโฮสต์ในหน้า GitHub คุณสามารถตั้งค่าการกระทำของ GitHub เพื่อปรับใช้เอกสารของคุณเป็นรหัสเว็บไซต์ mkdocs วิธีการหรือปรับใช้ด้วยตนเองโดยใช้:

 mkdocs gh-deploy

การบริจาค

หากคุณต้องการมีส่วนร่วมในที่เก็บข้อมูลนี้โปรดอย่าลังเลที่จะเปิดคำขอดึงหรือปัญหา เรายินดีต้อนรับข้อเสนอแนะคำแนะนำหรือการปรับปรุงรหัส

ใบอนุญาต

ที่เก็บนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT ดูไฟล์ LICENSE สำหรับข้อมูลเพิ่มเติม