search

ejplatform / ej-server

EJ uses gamification and machine learning to promote discussions and participation in a virtual democracy
https://ejplatform.github.io/ej-server/
Other
38 stars 17 forks source link

I15 generate documentation #750

Closed davialvb closed 5 years ago

davialvb commented 5 years ago

Descrição

Gera documentação de código de forma automatizada.

Issues Relacionadas

https://github.com/gces-empjuntos/ej-server/issues/15

Checklist

Ao tentar rodar o configure.sh obtive um erro do Django quando cria "createfakeconversations" como segue a imagem.

image

Não tenho certeza mas acho que isso afetou o funcionamento do sphinx pois alguns arquivos python deram erros ao tentar gerar a documentação.

image

Gostaria de pedir que possam verificar em suas maquinas que não possuem o mesmo erro do django citado acima e se esses outros 2 docs que estão dando erro funcionam corretamente.

Há arquivos sem depende cia que deram certo como o "forms" do EJ. Então considero que a issue foi resolvida por está gerando a documentação de código de forma automatizada como segue a imagem. Como issue futura sugiro a adição de documentação nos códigos para que o sphinx possa pegar o cabeçalho de forma correta e a adição de todos os outros códigos que não entraram.

image

ghost commented 5 years ago

DeepCode Report (#d89fcf)

DeepCode analyzed this pull request. There are no new issues.