MkAutoDocs

GPT-3.5 Kode Dokumentasi Repositori

Repositori ini menampilkan penggunaan model bahasa GPT-3.5 Openai untuk menghasilkan dokumentasi untuk kode secara otomatis. Dokumentasi yang dihasilkan kemudian diubah menjadi situs "dokumen sebagai kode" untuk akses dan berbagi yang mudah.

Memulai

Untuk menggunakan repositori ini, Anda harus memiliki yang berikut:

• Kunci API OpenAI yang valid untuk model bahasa GPT-3.5.
• Basis kode yang ingin Anda buat dokumentasi.

Penggunaan

1. Klon atau unduh repositori ini ke mesin lokal Anda.
2. Siapkan tombol API OpenAI Anda dengan membuat file .env di direktori root dan menambahkan baris berikut, Anda dapat mengganti nama contoh.env:

 OPENAI_API_KEY=<your-api-key>

1. Instal dependensi yang diperlukan, Python, lalu setelah diinstal Gunakan perintah berikut:

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

4. Edit file konfigurasi untuk menunjuk ke repositori kode Anda.
   1. DOCS_PATH: Jalur relatif ke folder DOC yang diinginkan (harus cocok dengan MKDOCS dalam file config).
   2. root_dir: jalur absolut atau jalur relatif ke direktori root proyek yang diinginkan.
   3. source_to_document:
      • Jalur absolut atau jalur relatif ke folder yang ingin Anda parsed dan didokumentasikan di direktori root Anda.
   4. Persyaratan: Daftar dependensi Python untuk menjalankan dokumen Anda sebagai situs kode.
      • MKDOCS: 1.4.2
      • Pymdown-Extensions: 9.11
   5. Abaikan_Folders: Daftar regex folder/subfolder untuk diabaikan. Hapus semua atau semua jika Anda suka.
      • .+. git
      • .pytest
      • Termasuk
      • Lib
      • Skrip
   6. Abaikan_files: Daftar file regex untuk diabaikan. Hapus semua atau semua jika Anda suka.
      • .*
      • ^(?! .py $).
   7. Use_State: Nilai boolean, ini akan membuat file tidak diregenerasi pada setiap proses. Jangan ragu untuk mati jika Anda ingin memperbarui dokumen.
5. Jalankan perintah berikut untuk menghasilkan dokumentasi untuk kode Anda:

 python Auto_Doc.py

Ini akan menggunakan model bahasa GPT-3.5 untuk menghasilkan dokumentasi untuk basis kode Anda dan mengeluarkan dokumentasi yang dihasilkan sebagai file penanda tangan dalam direktori docs yang dikonfigurasi.

1. Jalankan generator situs statis MKDOCS untuk mengubah dokumentasi yang dihasilkan menjadi situs "dokumen as code".

Misalnya, untuk menggunakan MKDOCS, jalankan perintah berikut di direktori root untuk melihat pratinjau situs:

 mkdocs serve

Atau gunakan MKDOCS, untuk membangun situs:

 mkdocs build

Ini akan menghasilkan situs web statis di direktori site , yang dapat Anda host di server atau layanan seperti halaman github.

Jika Anda ingin menjadi tuan rumah di halaman GitHub. Anda dapat mengatur tindakan github untuk secara otomatis Autodeploy dokumen Anda sebagai situs kode mkdocs cara atau digunakan secara manual menggunakan:

 mkdocs gh-deploy

Berkontribusi

Jika Anda ingin berkontribusi pada repositori ini, jangan ragu untuk membuka permintaan tarik atau masalah. Kami menyambut umpan balik, saran, atau peningkatan kode.

Lisensi

Repositori ini dilisensikan di bawah lisensi MIT. Lihat file LICENSE untuk informasi lebih lanjut.