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 a proper documentation #37

Open
4 tasks
diegoferigo opened this issue Sep 17, 2019 · 1 comment
Open
4 tasks

Add a proper documentation #37

diegoferigo opened this issue Sep 17, 2019 · 1 comment

Comments

@diegoferigo
Copy link
Member

diegoferigo commented Sep 17, 2019

Edit: I converted this issue to be more generic. Every time we find something that still needs to be documented, we can reference this issue.


As #36 (comment) and #36 (comment), we should provide reference documentation page we can link every time we need to refer to the notation used in our code.

  • Link velocity (both linear and angular parts)
  • Link orientation
  • External forces
  • Contact forces
@diegoferigo
Copy link
Member Author

A first draft of a sphinx-base website has been implemented in #195. They website is still empty and I leave this issue open to track the progresses.

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

No branches or pull requests

1 participant