You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
O projeto atualmente não conta com muita documentação. A ideia é trazer a biblioteca Pydoc ao projeto e permitir o uso da mesma para a documentação do sistema.
Procedimento
Verificar os requisitos para a utilização do Pydoc.
Estudar o funcionamento da biblioteca.
Fazer as modificações necessárias no projeto para que o mesmo possa gerar documentação com o Pydoc.
A documentação gerada deve ser adicionada ao diretório doc na raíz do projeto.
Escrever passo-a-passo de como gerar a documentação do sistema utilizando o Pydoc e anexar esse documento no diretório doc na raíz do projeto.
Observações
Documentações referentes aos padrões do Pydoc e a como utilizar a ferramente podem ser encontradas nos seguintes locais:
Após concluídas as tarefas, marcá-las como concluídas no Issue e commitar as mudanças. Realizar um pull request para o master adicionando o número da Issue no comentário.
The text was updated successfully, but these errors were encountered:
Objetivo
O projeto atualmente não conta com muita documentação. A ideia é trazer a biblioteca Pydoc ao projeto e permitir o uso da mesma para a documentação do sistema.
Procedimento
Observações
Documentações referentes aos padrões do Pydoc e a como utilizar a ferramente podem ser encontradas nos seguintes locais:
Conclusão
Após concluídas as tarefas, marcá-las como concluídas no Issue e commitar as mudanças. Realizar um pull request para o master adicionando o número da Issue no comentário.
The text was updated successfully, but these errors were encountered: