Live de Python sobre documentação usando o SPHINX

[kylefelipe]

Então... tivemos outro dia uma live sobre MkDocks (SENSACIONAL) Que tal uma usando o Sphinx, pra vermos a diferença entre elas?

[dunossauro]

Eu tava até comentando com @allythy sobre essa live. Depois troquei uma ideia com o @rennerocha. Vamos ver quando a gente consegue marcar

[KernelGM]

@dunossauro quando que sai essa live, meu bom? Ia ser otimo aprender sphinx com o mestre! Obrigado pelas aulas.

[adorilson]

Diretamente da keynote (vendo online) na Python Brasil 2022: precisamos dessa live de Sphinx. (Chama a Melissa, quem sabe...)

[alvesgf16]

Queremos essa live de Sphinx!

[lucaslrodri]

Eu também adoraria, pq eu não achei nem conteúdos gringos de qualidade no yt. E não precisaria usar o RST, pq o Sphinx também suporta Markdown via MyST e dá para fazer documentações muito bonitas com isso também.

O grande diferencial que eu vejo é a possiblidade de exportar a documentação em praticamente qualquer formato (HTML, PDF, LaTeX, Word, etc), que é ótimo para escrever livros, e a integração com Jupyter Notebooks (Para quem usa).

Eu vou passar minha contribuição com alguns links que eu achei falando do Sphinx + Markdown (MySTmd):

• Documentação do Sphinx: https://www.sphinx-doc.org/en/master/usage/markdown.html
• Documentação do Myst Parser: https://myst-parser.readthedocs.io/en/latest/
• Um post explicando como integrar Myst + Sphinx: https://www.lucasshen.com/notes/sphinx-md2html/sphinx-md2html
• Outro blog explicando sobre a marcação mystmd: https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide-myst/
• Documentação do Mystmd (Mystdmd+ Jupyter Notebooks): https://mystmd.org/guide
• Temas do Sphinx (Pelo que eu vi o Book é compatível, não sei se todos são compatíveis): https://sphinx-themes.org/

PS: Se eu achar mais alguma informação eu adiciono aqui.