-
Notifications
You must be signed in to change notification settings - Fork 39
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
Add Sphinx build config and more user docs, docstrings, type annotations, etc. #70
Conversation
ddafc82
to
1be7b96
Compare
Codecov Report
@@ Coverage Diff @@
## master #70 +/- ##
==========================================
+ Coverage 98.15% 98.18% +0.02%
==========================================
Files 8 8
Lines 380 386 +6
Branches 34 33 -1
==========================================
+ Hits 373 379 +6
Misses 4 4
Partials 3 3
Continue to review full report at Codecov.
|
4b83c97
to
8ed0a97
Compare
@JWCook Looks great to me |
6b7cd3a
to
3fc7221
Compare
@vutran1710 Okay, I think this is ready to go. I did a manual build from my branch so you can see a preview here: https://pyrate-limiter.readthedocs.io Were you able to add that webhook to trigger doc builds? Details here. Once that's done, it will rebuild the docs every time you push to the master branch. Or it can be built only for git tags or other conditions, if you prefer. |
Closes #69, updates #49
Let me know if you have any questions about how Sphinx works or about the extensions used. These tools have a bit of a learning curve, but once everything is set up you can mostly forget about it.
Besides the changes to build and publish docs, I've added and edited quite a bit of documentation, mainly in the Readme. A diff is not very useful here, so see the rendered doc instead: https://github.com/JWCook/PyrateLimiter/blob/docs/README.md
I've tried to organize it roughly in order of what I think a new user will want to know first:
Please look that over and let me know what you think.