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

Add API documentation #41

Closed
jessicaaustin opened this issue Feb 28, 2020 · 1 comment
Closed

Add API documentation #41

jessicaaustin opened this issue Feb 28, 2020 · 1 comment

Comments

@jessicaaustin
Copy link

I might be missing something, but I don't see docs for the API at https://cotede.readthedocs.io/en/latest/readme.html

Looks like the code as docstrings for most classes and test methods, so this is probably just a matter of configuring sphinx to produce the docs.

castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 11, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 12, 2020
Addressing issue #41
castelao added a commit that referenced this issue Mar 13, 2020
Addressing issue #41
@castelao
Copy link
Owner

@jessicaaustin , thanks for raising this issue. I updated the documentation (https://cotede.readthedocs.io) to include the main resources that a new user should know. I'll soon finish cleaning the code of this package, and then I'll be able to use the automatic mode for a more extensive documentation coverage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants