MkAutoDocs

Repositório de documentação do código GPT-3.5

Este repositório mostra o uso do modelo de idioma GPT-3.5 do OpenAI para gerar documentação para o código automaticamente. A documentação gerada é então transformada em um site "Doc como código" para facilitar o acesso e o compartilhamento.

Começando

Para usar este repositório, você precisará ter o seguinte:

• Uma chave de API do OpenAI válida para o modelo de idioma GPT-3.5.
• Uma base de código para a qual você deseja gerar documentação.

Uso

1. Clone ou faça o download deste repositório para sua máquina local.
2. Configure sua chave da API do OpenAI, criando um arquivo .env no diretório raiz e adicionando a linha a seguir, você pode renomear o exemplo.env:

 OPENAI_API_KEY=<your-api-key>

1. Instale as dependências necessárias, Python e depois instalado, use o seguinte comando:

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

4. Edite o arquivo de configuração para apontar para o seu repositório de código.
   1. DOCS_PATH: caminho relativo para a pasta DOC desejada (deve corresponder aos MKDocs no arquivo de configuração).
   2. root_dir: caminho absoluto ou caminho relativo para o diretório raiz do projeto desejado.
   3. fonte_to_document:
      • Caminho absoluto ou caminho relativo para as pastas que você deseja analisar e documentar no seu diretório raiz.
   4. Requisitos: Uma lista de dependências do Python para executar seu documento como site de código.
      • Mkdocs: 1.4.2
      • Pymdown-Extensões: 9.11
   5. ignore_folders: uma lista de regex de pastas/subpastas para ignorar. Remova qualquer um ou tudo, se quiser.
      • .+. git
      • .pytest
      • Incluir
      • Lib
      • Scripts
   6. ignore_files: uma lista de regex de arquivos a serem ignorados. Remova qualquer um ou tudo, se quiser.
      • .*
      • ^(?! .py $).
   7. use_state: um valor booleano, isso impedirá que os arquivos sejam regenerados em cada execução. Sinta -se à vontade para desligar se quiser atualizar os documentos.
5. Execute o seguinte comando para gerar documentação para o seu código:

 python Auto_Doc.py

Isso usará o modelo de idioma GPT-3.5 para gerar documentação para a sua base de código e produzirá a documentação gerada como arquivos de marcação no diretório docs configurado.

1. Execute os MKDOCs do gerador de sites estáticos para transformar a documentação gerada em um site "DOC como código".

Por exemplo, para usar o MKDOCS, execute o seguinte comando no diretório raiz para visualizar o site:

 mkdocs serve

Ou use MKDOCs, para construir um site:

 mkdocs build

Isso gerará um site estático no diretório site , que você pode hospedar em um servidor ou um serviço como as páginas do GitHub.

Se você deseja hospedar em páginas do Github. Você pode configurar ações do GitHub para implantar automaticamente seu documento como o site de código mkdocs como fazer ou implantar manualmente usando:

 mkdocs gh-deploy

Contribuindo

Se você deseja contribuir com este repositório, sinta -se à vontade para abrir uma solicitação de tração ou um problema. Congratulamo -nos com qualquer feedback, sugestões ou melhorias no código.

Licença

Este repositório é licenciado sob a licença do MIT. Consulte o arquivo LICENSE para obter mais informações.