[python] Get readthedocs going
#1098
Conversation
Codecov ReportPatch coverage:
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #1098 +/- ##
===========================================
+ Coverage 61.17% 91.31% +30.14%
===========================================
Files 81 30 -51
Lines 5906 2281 -3625
===========================================
- Hits 3613 2083 -1530
+ Misses 2293 198 -2095
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 51 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
johnkerl
force-pushed
the
kerl/readthedocs-initial
branch
from
745af57 to
4e8712b
Compare
| @@ -3,7 +3,8 @@ | |||
| # | |||
| # Licensed under the MIT License. | |||
|
|
|||
| """Implementation of SOMA DenseNDArray. | |||
| """ | |||
| Implementation of SOMA DenseNDArray. | |||
There was a problem hiding this comment.
I also prefer the newline between the triple quote and the text, but the Google guidelines for the docstrings don't have it. If we all like this style better, maybe we should make an exception but then we should make it consistent across the codebase.
There was a problem hiding this comment.
@ebezzi these were for sphinx/readthedocs render errors
unfortunately if it's a render error for webdocs vs a stylistic/guideline preference for google docs, we must go with the way that avoids a render error
There was a problem hiding this comment.
Weird 🤔 I was expecting napoleon to parse it correctly. Anyway, let's go with what works!
Issue and/or context: #1041
Changes:
Gets Python API docs into
readthedocs.Notes for Reviewer:
Current preview link (not on main): https://tiledbsoma.readthedocs.io/en/kerl-readthedocs-initial/python-api.html
There's more work to do but this gets the bulk of the docs available on the web for users to see. In particular
readthdocsstill needs a button poked manually; I don't have commit-triggers set up. Also some info about this (and R'spkgdown) needs to be written in this repo's developer wiki.