1
resposta

[Sugestão] Dica: Visualizar docstrings em um arquivo HTML

Para quem tiver interesse, pesquisei e vi algumas libs para visualizar as docstrings em formato HTML. Escolhi a pdoc por ser bem simples de configurar.

Para instalar, execute:

pip install pdoc

Para gerar a doc, execute:

pdoc --output-dir docs app.py

app.py é o nome do arquivo onde tem todas as funções que documentei.

Será gerada uma pasta chamada docs onde tem um arquivo html que pode ser redenrizado.

1 resposta

Olá, Estudante.

Tudo bem?

Excelente dica! Utilizar o pdoc para gerar a documentação em HTML é uma ótima prática, principalmente para quem deseja manter a documentação acessível e visualmente organizada. Isso pode ser muito útil em projetos colaborativos ou mesmo para consulta pessoal.

Muito bom. Obrigado por compartilhar com a gente. Parabéns!!

O fórum está à disposição para qualquer dúvida ou sugestão que você tenha. Abraços!