Skip to content
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

Merged
merged 9 commits into from
Oct 25, 2021

Conversation

hyrodium
Copy link
Collaborator

I've added documentation with Documenter.jl.

Screenshot:

Peek 2021-10-23 19-37

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.

@codecov
Copy link

codecov bot commented Oct 23, 2021

Codecov Report

Merging #169 (a3d37a2) into master (3668fae) will increase coverage by 0.18%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
src/mrps.jl 34.02% <0.00%> (ø)
src/unitquaternion.jl 96.17% <0.00%> (ø)
src/rodrigues_params.jl 98.63% <0.00%> (ø)
src/euler_types.jl 92.43% <0.00%> (+0.20%) ⬆️
src/angleaxis_types.jl 93.81% <0.00%> (+0.40%) ⬆️
src/core_types.jl 90.67% <0.00%> (+0.76%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3668fae...a3d37a2. Read the comment docs.

Copy link
Contributor

@andyferris andyferris left a 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.

@andyferris
Copy link
Contributor

What do you use to record the video screenshot?

@hyrodium hyrodium merged commit c199f51 into JuliaGeometry:master Oct 25, 2021
@hyrodium
Copy link
Collaborator Author

I use peek to record screenshot. 🎥
https://github.com/phw/peek

@hyrodium
Copy link
Collaborator Author

The documentation has been deployed:tada:
https://juliageometry.github.io/Rotations.jl/dev/

@andyferris
Copy link
Contributor

Awesome, looking good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants