MkAutoDocs

Repositorio de documentación de código GPT-3.5

Este repositorio muestra el uso del modelo de lenguaje GPT-3.5 de Openai para generar documentación para el código automáticamente. La documentación generada se convierte en un sitio de "documento como código" para facilitar el acceso y el intercambio.

Empezando

Para usar este repositorio, deberá tener lo siguiente:

• Una tecla API OpenAI válida para el modelo de idioma GPT-3.5.
• Una base de código para la que desea generar documentación.

Uso

1. Clon o descargue este repositorio a su máquina local.
2. Configure su tecla API de OpenAI creando un archivo .env en el directorio raíz y agregando la siguiente línea, puede cambiar el nombre del ejemplo.env:

 OPENAI_API_KEY=<your-api-key>

1. Instale las dependencias requeridas, Python, luego una vez instalado, use el siguiente comando:

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

4. Edite el archivo de configuración para señalar su repositorio de código.
   1. docs_path: ruta relativa a la carpeta DOC deseada (debería coincidir con MKDOCS en el archivo de configuración).
   2. root_dir: ruta absoluta o ruta relativa al directorio de raíz del proyecto deseado.
   3. fuente_to_document:
      • Ruta absoluta o ruta relativa a las carpetas que desea analizar y documentar en su directorio raíz.
   4. Requisitos: una lista de dependencias de Python para ejecutar su documento como sitio de código.
      • Mkdocs: 1.4.2
      • Pymdown-Extensions: 9.11
   5. Ignore_folders: una lista de reglas de carpetas/subcarpetas para ignorar. Elimine cualquiera o todo si lo desea.
      • .+. Git
      • .
      • Incluir
      • Lib
      • Guiones
   6. Ignore_files: una lista de regex de archivos para ignorar. Elimine cualquiera o todo si lo desea.
      • .*
      • ^(?!.. .py $).
   7. Use_state: un valor booleano, esto evitará que los archivos se regeneran en cada ejecución. Siéntase libre de apagar si desea actualizar los documentos.
5. Ejecute el siguiente comando para generar documentación para su código:

 python Auto_Doc.py

Esto utilizará el modelo de lenguaje GPT-3.5 para generar documentación para su código de código y emitirá la documentación generada como archivos de Markdown en el directorio docs configurados.

1. Ejecute el generador de sitio estático MKDOC para convertir la documentación generada en un sitio de "DOC como código".

Por ejemplo, para usar MKDOCS, ejecute el siguiente comando en el directorio raíz para obtener una vista previa del Sitio:

 mkdocs serve

O usar MKDOC, para construir un sitio:

 mkdocs build

Esto generará un sitio web estático en el directorio site , que puede alojar en un servidor o un servicio como las páginas GitHub.

Si quieres alojar en las páginas de GitHub. Puede configurar las acciones de GitHub para autodepluir su documento como sitio de código MKDOCS cómo o implementar manualmente usando:

 mkdocs gh-deploy

Que contribuye

Si desea contribuir a este repositorio, no dude en abrir una solicitud de extracción o un problema. Agradecemos cualquier comentario, sugerencia o mejoras al código.

Licencia

Este repositorio tiene licencia bajo la licencia MIT. Consulte el archivo LICENSE para obtener más información.