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

API documentation #6

Open
steven-murray opened this issue Aug 28, 2019 · 0 comments
Open

API documentation #6

steven-murray opened this issue Aug 28, 2019 · 0 comments
Assignees
@zacharymartinot

Comments

@steven-murray
Copy link
Collaborator

Some automatic API documentation would go a long way towards making the package more usable. I advocate using numpydoc style docstrings exhaustively, and Sphinx to create the docs, hosted on readthedocs.org.

Apart from the actual docstring-writing, this should take ~1hr to set up.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zacharymartinot zacharymartinot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steven-murray @zacharymartinot