Criação de uma documentação técnica mais robusta

DP6 / Marketing-Attribution-Models

Python Class created to address problems regarding Digital Marketing Attribution.

https://dp6.github.io/Marketing-Attribution-Models

Apache License 2.0

302 stars 80 forks source link

Criação de uma documentação técnica mais robusta #26

Open andretocci opened 3 years ago

andretocci commented 3 years ago

Hoje temos apenas a documentação presente no Git Hub que é genérica. Creio que faça sentido fazermos uma documentação como a do Pandas por exemplo.

iago commented 3 years ago

Podemos analisar soluções que criam documentações automaticamente com base nos docstrings do código, um exemplo é o Sphinx, que exporta a doc para formatos diversos (PDF, HTML, etc.).

Post mostrando como usar