-
Notifications
You must be signed in to change notification settings - Fork 50
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
DOC: implement basic docs #58
Conversation
Codecov Report
@@ Coverage Diff @@
## master #58 +/- ##
=======================================
Coverage 99.51% 99.51%
=======================================
Files 3 3
Lines 413 413
=======================================
Hits 411 411
Misses 2 2
Continue to review full report at Codecov.
|
Thank you for this PR. I need to figure out how to make readthedocs play well with poetry... |
This is looking good now. I added a couple of goodies to like linking to GH, borrowed from Skorch/sklearn. Since this does not modify any of the existing docs or functionality, I'm going to merge as-is and we can improve these docs as we go. |
What does this PR implement?
It provides basic API documentation. This PR does not provide a getting started guide, examples or tutorials.
I think focusing on documentation will help simplify the API.
References issues/PRs
This closes #46.