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

DOC: implement basic docs #58

Merged
merged 15 commits into from
Aug 16, 2020
Merged

DOC: implement basic docs #58

merged 15 commits into from
Aug 16, 2020

Conversation

stsievert
Copy link
Collaborator

@stsievert stsievert commented Aug 15, 2020

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.

@codecov-commenter
Copy link

codecov-commenter commented Aug 15, 2020

Codecov Report

Merging #58 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #58   +/-   ##
=======================================
  Coverage   99.51%   99.51%           
=======================================
  Files           3        3           
  Lines         413      413           
=======================================
  Hits          411      411           
  Misses          2        2           
Impacted Files Coverage Δ
scikeras/wrappers.py 99.70% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf7ea78...bb09b08. Read the comment docs.

@adriangb
Copy link
Owner

Thank you for this PR. I need to figure out how to make readthedocs play well with poetry...

@adriangb
Copy link
Owner

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.

@adriangb adriangb merged commit d9f5833 into adriangb:master Aug 16, 2020
@adriangb adriangb deleted the sphinx-docs branch August 16, 2020 05:18
@adriangb adriangb mentioned this pull request Aug 18, 2020
@stsievert stsievert mentioned this pull request Aug 27, 2020
17 tasks
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

Successfully merging this pull request may close these issues.

MAINT/DOC: Documentation overhaul
3 participants