21/10/2025 –, Impacta - Sala 208
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ê!)
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.
Conhecimento básico de Python, experiência com git/controle de versão são necessários. Alguma experiência em desenvolvimento de software, data science ou áreas correlatas é interessante. Se tiverem algum conteúdo de documentação que desejam usar como exemplo (como uma coleção de arquivos texto/markdown/rst ou até um pacote Python com docstrings) podem trazer para usarmos durante o tutorial.
O que as pessoas que participarem podem esperar aprender na sua atividade? –O objetivo do tutorial é explicar os processos envolvidos na criação, configuração e deploy de um site estático de documentação para que sejam capazes de realizar isso no futuro (talvez usando esse site criado durante o tutorial como exemplo). Um dos focos é também tirar dúvidas e abordar problemas comuns que podem surgir durante esse processo, facilitando o processo de criar documentação bonita e organizada para bibliotecas Python.
Escolha uma ou mais áreas em que essa proposta se encaixa –Outros
Melissa é matemática e Senior DevEx Engineer na Quansight. É mantenedora da NumPy e da SciPy, entusiasta de software livre, e acredita no poder da diversidade, equidade e inclusão.