MkAutoDocs

Référentiel de documentation du code GPT-3.5

Ce référentiel présente l'utilisation du modèle de langue GPT-3.5 d'OpenAI pour générer automatiquement la documentation pour le code. La documentation générée est ensuite transformée en un site "Doc as Code" pour un accès et un partage faciles.

Commencer

Pour utiliser ce référentiel, vous devrez avoir ce qui suit:

• Une clé API OpenAI valide pour le modèle de langue GPT-3.5.
• Une base de code pour laquelle vous souhaitez générer de la documentation.

Usage

1. Clone ou téléchargez ce référentiel sur votre machine locale.
2. Configurez votre clé API OpenAI en créant un fichier .env dans le répertoire racine et en ajoutant la ligne suivante, vous pouvez renommer l'exemple.env:

 OPENAI_API_KEY=<your-api-key>

1. Installez les dépendances requises, Python, puis une fois installé, utilisez la commande suivante:

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

4. Modifiez le fichier de configuration pour pointer vers votre référentiel de code.
   1. DOCS_PATH: chemin relatif vers le dossier DOC souhaité (devrait correspondre avec les MKDOC dans le fichier de configuration).
   2. root_dir: chemin absolu ou chemin relatif vers le répertoire racine du projet souhaité.
   3. source_to_document:
      • Chemin absolu ou chemin relatif aux dossiers que vous souhaitez analyser et documenter dans votre répertoire racine.
   4. Exigences: une liste des dépendances Python pour exécuter votre site Doc en tant que site de code.
      • MKDOCS: 1.4.2
      • pymdown-extensions: 9.11
   5. Ignore_folders: une liste de regex de dossiers / sous-dossiers à ignorer. Supprimer tout ou tous si vous le souhaitez.
      • . +. Git
      • .pytest
      • Inclure
      • Lib
      • Scripts
   6. Ignore_Files: une liste de regex de fichiers à ignorer. Supprimer tout ou tous si vous le souhaitez.
      • . *
      • ^ (?!. .py $).
   7. use_state: une valeur booléenne, cela empêchera les fichiers d'être régénérés à chaque exécution. N'hésitez pas à désactiver si vous souhaitez mettre à jour les documents.
5. Exécutez la commande suivante pour générer de la documentation pour votre code:

 python Auto_Doc.py

Cela utilisera le modèle de langue GPT-3.5 pour générer de la documentation pour votre base de code et publiera la documentation générée en tant que fichiers Markdown dans le répertoire docs configuré.

1. Exécutez le générateur de sites statique MKDOCS pour transformer la documentation générée en un site "Doc as Code".

Par exemple, pour utiliser MKDOCS, exécutez la commande suivante dans le répertoire racine pour prévisualiser le site:

 mkdocs serve

Ou utilisez des MKDOC pour construire un site:

 mkdocs build

Cela générera un site Web statique dans le répertoire site , que vous pouvez héberger sur un serveur ou un service comme les pages GitHub.

Si vous souhaitez héberger sur les pages GitHub. Vous pouvez configurer des actions GitHub pour automatiquement votre DOC en tant que site de code Mkdocs comment ou déployer manuellement en utilisant:

 mkdocs gh-deploy

Contributif

Si vous souhaitez contribuer à ce référentiel, n'hésitez pas à ouvrir une demande de traction ou un problème. Nous nous félicitons de toute rétroaction, suggestions ou améliorations du code.

Licence

Ce référentiel est concédé sous licence MIT. Voir le fichier LICENSE pour plus d'informations.