Python Brasil 2025
21/10/2025
Sala 208
pt-br
Documentar é só o começo!
Iniciante
Aprenda do zero a documentar pacotes Python com tranquilidade! Vamos falar de GitHub, Sphinx, MkDocs, temas bonitos e deploy automático com GitHub Actions ou ReadTheDocs (a documentação é com você!)

Details

Você escreveu aquele pacote Python incrível, mas ainda está com um README.md sofrido e nenhum site de documentação? Calma, que **documentar é só o começo** — e você vai ver que é mais fácil (e mais bonito) do que parece.

Neste tutorial, você vai aprender, passo a passo, como criar um site de documentação profissional para o seu projeto Python. A jornada começa com o básico de **Git e GitHub**, passa pela estrutura de pastas, e vai até o deploy automático no **GitHub Pages** usando **GitHub Actions** ou **ReadTheDocs**.

Vamos explorar duas ferramentas populares de documentação:

- **Sphinx**, com direito a temas personalizados como o Furo e Read the Docs;

- **MkDocs**, incluindo o tema Material for MkDocs.

Além disso, você vai entender como escrever sua documentação em Markdown ou reStructuredText, como configurar arquivos como `conf.py` ou `mkdocs.yml`, e como deixar tudo integrado ao seu fluxo de desenvolvimento.

No final, seu projeto vai ter um site bonito, funcional e hospedado automaticamente, pronto pra impressionar colegas, recrutadores e até o seu eu do futuro.