MkAutoDocs

GPT-3.5-Code-Dokumentation Repository

Dieses Repository zeigt die Verwendung des GPT-3.5-Sprachmodells von OpenAI zur automatischen Generierung von Dokumentationen für Code. Die generierte Dokumentation wird dann in eine Site "DOC AS Code" umgewandelt, um einen einfachen Zugriff und die Freigabe zu erhalten.

Erste Schritte

Um dieses Repository zu verwenden, müssen Sie Folgendes haben:

• Ein gültiger OpenAI-API-Schlüssel für GPT-3.5-Sprachmodell.
• Eine Codebasis, für die Sie Dokumentation generieren möchten.

Verwendung

1. Klonen oder laden Sie dieses Repository auf Ihren lokalen Computer herunter.
2. Richten Sie Ihre OpenAI -API -Schlüssel ein, indem Sie eine .env -Datei im Stammverzeichnis erstellen und die folgende Zeile hinzufügen. Sie können das Beispiel umbenennen.

 OPENAI_API_KEY=<your-api-key>

1. Installieren Sie die erforderlichen Abhängigkeiten, Python und verwenden Sie dann den folgenden Befehl:

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

4. Bearbeiten Sie die Konfigurationsdatei so, dass sie auf Ihr Code -Repository verweist.
   1. DOCS_PATH: Relativer Pfad zum gewünschten DOC -Ordner (sollte mit MKDOCs in der Konfigurationsdatei übereinstimmen).
   2. root_dir: Absolutes Pfad oder relativer Pfad zum gewünschten Projekt Root -Verzeichnis.
   3. SCRECT_TO_DOCUMENT:
      • Absolute Pfad oder relativer Pfad zu den Ordnern, die Sie in Ihrem Stammverzeichnis analysieren und dokumentiert haben.
   4. Anforderungen: Eine Liste der Python -Abhängigkeiten, um Ihr DOC als Code -Site auszuführen.
      • Mkdocs: 1.4.2
      • PyMdown-Extensions: 9.11
   5. Ignore_Folders: Eine Liste von Regex von Ordnern/Unterordnern zu ignorieren. Entfernen Sie alle oder alles, wenn Sie möchten.
      • .+. Git
      • .PyTest
      • Enthalten
      • Lib
      • Skripte
   6. Ignore_files: Eine Liste von Regex von Dateien zu ignorieren. Entfernen Sie alle oder alles, wenn Sie möchten.
      • .*
      • ^(?! .Py $).
   7. Use_State: Ein boolescher Wert, damit die Dateien bei jedem Lauf wiederhergestellt werden. Fühlen Sie sich frei zu deaktivieren, wenn Sie die Dokumente aktualisieren möchten.
5. Führen Sie den folgenden Befehl aus, um Dokumentation für Ihren Code zu generieren:

 python Auto_Doc.py

Dadurch wird das GPT-3.5-Sprachmodell verwendet, um eine Dokumentation für Ihre Codebasis zu generieren und die generierte Dokumentation als Markdown-Dateien im konfigurierten docs Verzeichnis auszugeben.

1. Führen Sie den statischen Site -Generator MKDOCs aus, um die generierte Dokumentation in eine Site "DOC as Code" zu verwandeln.

Führen Sie beispielsweise MKDOCs zur Verwendung von MKDOCs im Root -Verzeichnis den folgenden Befehl aus, um die Site anzunehmen:

 mkdocs serve

Oder verwenden Sie MKDOCs, um eine Website zu erstellen:

 mkdocs build

Dies generiert eine statische Website im site -Verzeichnis, die Sie auf einem Server oder einem Dienst wie GitHub -Seiten hosten können.

Wenn Sie auf Github -Seiten hosten möchten. Sie können GitHub -Aktionen einrichten, um Ihr DOC als Code -Site MKDOCS zu automatisieren, wie oder manuell mit:

 mkdocs gh-deploy

Beitragen

Wenn Sie zu diesem Repository beitragen möchten, können Sie bitte eine Pull -Anfrage oder ein Problem öffnen. Wir begrüßen Feedback, Vorschläge oder Verbesserungen des Codes.

Lizenz

Dieses Repository ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie in der LICENSE .