basic api docs #41
Merged
basic api docs #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #41 +/- ##
==========================================
+ Coverage 95.20% 95.48% +0.27%
==========================================
Files 1 1
Lines 396 509 +113
==========================================
+ Hits 377 486 +109
- Misses 19 23 +4
Continue to review full report at Codecov.
|
|
going to merge this to get it working on rtd... we can adjust it plenty in future PRs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this adds sphinx docs.
plenty of room for improvement... but since it's hard to "peruse" the source code here, this should make it slightly easier to look around the generated code API (at readthedocs).