MkAutoDocs

GPT-3.5 Кодовая документация репозиторий

Этот репозиторий демонстрирует использование языковой модели GPT-3.5 от OpenAI для автоматического создания документации для кода. Сгенерированная документация затем превращается в сайт «Doc As Code» для легкого доступа и обмена.

Начиная

Чтобы использовать этот репозиторий, вам нужно будет иметь следующее:

• Допустимый ключ OpenAI API для языковой модели GPT-3.5.
• Кодовая база, для которой вы хотите создать документацию.

Использование

1. Клонировать или загрузите это хранилище на местную машину.
2. Установите свой ключ API OpenAI, создав файл .env в каталоге ROOT и добавив следующую строку, вы можете переименовать пример.env:

 OPENAI_API_KEY=<your-api-key>

1. Установите требуемые зависимости, Python, затем после установки используйте следующую команду:

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

4. Отредактируйте файл конфигурации, чтобы указывать на ваш кодовый репозиторий.
   1. DOCS_PATH: относительный путь к желаемой папке DOC (должен соответствовать MKDOC в файле конфигурации).
   2. ROOT_DIR: абсолютный путь или относительный путь к желаемому каталогу Project Root.
   3. Source_to_document:
      • Абсолютный путь или относительный путь к папкам, которые вы хотите проанализировать и задокументирован в вашем корневом каталоге.
   4. Требования: список зависимостей Python для запуска вашего DOC в качестве кодового сайта.
      • MKDOCS: 1.4.2
      • Pymdown-Extensions: 9.11
   5. Ignore_folders: список режимов папок/подпапок, чтобы игнорировать. Удалите любое или все, если хотите.
      • .+. Git
      • .pytest
      • Включать
      • Либеральный
      • Сценарии
   6. Ignore_files: список режимов файлов для игнорирования. Удалите любое или все, если хотите.
      • .*
      • ^(?!. .py $).
   7. USE_STATE: логическое значение, это будет удерживать файлы от регенерирования при каждом запуске. Не стесняйтесь выключаться, если вы хотите обновить документы.
5. Запустите следующую команду для создания документации для вашего кода:

 python Auto_Doc.py

Это будет использовать языковую модель GPT-3.5 для генерации документации для вашей кодовой базы и вывести сгенерированную документацию в качестве файлов разметки в каталоге настроенных docs .

1. Запустите статический генератор сайтов MKDOCS, чтобы превратить сгенерированную документацию в сайт «Док как код».

Например, для использования MKDOCS запустите следующую команду в корневом каталоге для предварительного просмотра сайта:

 mkdocs serve

Или используйте MKDOCS, чтобы построить сайт:

 mkdocs build

Это будет генерировать статический веб -сайт в каталоге site , который вы можете размещать на сервере или службе, такой как страницы Github.

Если вы хотите разместить на страницах GitHub. Вы можете настроить действия GitHub, чтобы автоматически разместить свой документ в качестве кодового сайта mkdocs, как или развертывание вручную, используя:

 mkdocs gh-deploy

Внося

Если вы хотите внести свой вклад в этот репозиторий, пожалуйста, не стесняйтесь открыть запрос на тягу или проблему. Мы приветствуем любые отзывы, предложения или улучшения кода.

Лицензия

Этот репозиторий лицензирован по лицензии MIT. См. Файл LICENSE для получения дополнительной информации.