Add a proper documentation - Githubissues

robotology / gym-ignition

Framework for developing OpenAI Gym robotics environments simulated with Ignition Gazebo

https://robotology.github.io/gym-ignition

GNU Lesser General Public License v3.0

224 stars 26 forks source link

Add a proper documentation #37

Open diegoferigo opened 4 years ago

diegoferigo commented 4 years ago

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 https://github.com/robotology/gym-ignition/pull/36#discussion_r325129540 and https://github.com/robotology/gym-ignition/pull/36#discussion_r325136624, 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 commented 4 years ago

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.