Tutorial para documentação de código utilizando Sphinx

Tutorial básico para a instalação e utilização da ferramenta Sphinx para a documentação de código no projeto VerteSIS.

Tópicos:

• Visão geral
• Instalando o Sphinx
• Iniciando a documentação com o Sphinx
• Documentação do código utilizando Docstring
• Gerando documentação “automática”

Links úteis

• Site oficial do Sphinx - http://www.sphinx-doc.org/en/master/
• Sintaxe da linguagem de marcação rst - http://docutils.sourceforge.net/docs/user/rst/quickref.html
• Video tutorial 1 - https://www.youtube.com/watch?v=qrcj7sVuvUA
• Vídeo tutorial 2 - https://www.youtube.com/watch?v=LQ6pFgQXQ0Q