Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adicionar o uso do Pydoc ao projeto #9

Open
5 tasks
renanleonellocastro opened this issue May 19, 2020 · 0 comments
Open
5 tasks

Adicionar o uso do Pydoc ao projeto #9

renanleonellocastro opened this issue May 19, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@renanleonellocastro
Copy link
Owner

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

  • 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:

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.

@renanleonellocastro renanleonellocastro added the documentation Improvements or additions to documentation label May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant