-
Notifications
You must be signed in to change notification settings - Fork 1
Documentation improvements #35
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
base: master
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #35 +/- ##
=============================================
+ Coverage 81.92% 93.27% +11.34%
=============================================
Files 7 6 -1
Lines 1433 803 -630
Branches 56 0 -56
=============================================
- Hits 1174 749 -425
+ Misses 215 54 -161
+ Partials 44 0 -44 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I will probably not be able to work on this for over a week. But in case you want to add a job for the C API, you only need to install Otherwise I can do it when I get back and if you want this merged before that, you can remove C documentation from this PR and I create a separate one :) |
Signed-off-by: Sheldon <timhagenmail@googlemail.com>
With this PR, I would like to combine our efforts to improve the package documentation for all three languages.
The Javadoc is already build as part of the Maven release. At this PR's initial state, I have added support for generating a Read the Docs-compatible Python documentation based on docstrings. Maybe we can also deploy the C documentation somewhere?