-
Notifications
You must be signed in to change notification settings - Fork 25
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
Update documentation #159
Update documentation #159
Conversation
Codecov Report
@@ Coverage Diff @@
## master #159 +/- ##
=======================================
Coverage 77.07% 77.07%
=======================================
Files 11 11
Lines 724 724
=======================================
Hits 558 558
Misses 166 166
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
I furthermore removed a compat info in a docstring for Aqua v0.5. In my opinion, this either belongs to release notes, or should be added similarly everywhere else. This lonely one doesn't make sense to me. |
Co-authored-by: Yuto Horikawa <hyrodium@gmail.com>
Another slightly larger change: Much content of the README.md has been moved to the documentation. I didn't really like the previous hack to include the README.md as a docstring, and that lead to formatting issues. Now, the README.md is a lot shorter, as everything important has moved to the documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Just to double check, did you verify that the resulting HTML produced by Documenter looks the way it should / you expect it to look?
The doc preview unfortunately does not work since I work on a fork. But my local build looks good. |
Resolves #123.
I am happy to change anything, if requested.
If someone knows about a package following the best practices described here, I will gladly add it to the list.