Add Euler angles to Madgwick and update docs.

2019-08-06 23:42:51 -07:00
parent 85833c354d
commit ff3ff8d8b2
5 changed files with 22 additions and 5 deletions
--- a/docs/sphinx/index.rst
+++ b/docs/sphinx/index.rst
@@ -10,7 +10,7 @@ libwrmath: WNTRMUTE ROBOTICS' maths library
   :maxdepth: 3
   :caption: Contents:

-   api
+   overview
   vector
   quaternion
   resources
--- a/docs/sphinx/overview.rst
+++ b/docs/sphinx/overview.rst
@@ -15,7 +15,8 @@ Coordinate systems

 The library uses a left-hand coordinate system where +x is north, +y is
 east, and +z is up. Accordingly, where Euler angles are concerned, the
-ZYX (yaw / pitch / roll) axes are used.
+ZYX (yaw / pitch / roll) axes are used. The code follows the convention
+of using ψ, θ, ϕ to represent yaw, pitch, and roll.

 Important classes
 -----------------