Posts Tagged documentação

Como usamos Sphinx para documentar projetos Python

O Sphinx é uma ferramenta para facilitar a criação de documentações inteligentes e apresentáveis. Originalmente foi criado para documentar o novo Python 2.7, e por isso tem um excelente suporte para documentar projetos Python.

Dentre as inúmeras vantagens da ferramenta, o que mais nos chamou a atenção foi:

  • A usabilidade do site que o Sphinx gera;
  • A possibilidade de gerar documentação a partir de docstrings no código do projeto;
  • Facilidade de organizar e adicionar conteúdo à documentação, a partir de arquivos textos escritos em reStructuredText.

Leia o resto desse post »

, , , , , ,

2 Comentários