-
Notifications
You must be signed in to change notification settings - Fork 44
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 documentation with Documenter.jl #169
Conversation
Codecov Report
@@ Coverage Diff @@
## master #169 +/- ##
==========================================
+ Coverage 85.76% 85.95% +0.18%
==========================================
Files 12 12
Lines 1286 1289 +3
==========================================
+ Hits 1103 1108 +5
+ Misses 183 181 -2
Continue to review full report at Codecov.
|
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.
Fantastic! We should definitely add these.
I haven't checked it word-for-word but its something that can safely evolve over time, so we should just merge it.
What do you use to record the video screenshot? |
I use peek to record screenshot. 🎥 |
The documentation has been deployed:tada: |
Awesome, looking good! |
I've added documentation with Documenter.jl.
Screenshot:
Some areas are not documented yet, but it is hard to make a complete document in one PR, so I would like to merge the current one for now.