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.

Sign up for GitHub

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

Jump to bottom

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

Open
andretocci opened this issue Jun 11, 2021 · 1 comment
Open

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

andretocci opened this issue Jun 11, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@andretocci
Copy link
Collaborator

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.
@andretocci andretocci added the documentation Improvements or additions to documentation label Jun 11, 2021
@iago
Copy link
Contributor

iago commented Jun 14, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@iago @andretocci