Add pages of ecef2geodetic, geodetic2ecef, and geodetic2enu.

Mayitzin · Jan 5, 2025 · 41721fc · 41721fc
1 parent 93feb12
commit 41721fc
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 10 deletions.
diff --git a/ahrs/common/frames.py b/ahrs/common/frames.py
@@ -234,7 +234,7 @@ def ecef2geodetic(x: float, y: float, z: float, a: float = EARTH_EQUATOR_RADIUS,
 
     .. math::
 
-            h = \\frac{p}{\\cos\\phi} - N
+        h = \\frac{p}{\\cos\\phi} - N
 
     .. note::
 

diff --git a/docs/source/frames/ecef2geodetic.rst b/docs/source/frames/ecef2geodetic.rst
@@ -0,0 +1,4 @@
+ecef2geodetic
+=============
+
+.. autofunction:: ahrs.common.frames.ecef2geodetic
diff --git a/docs/source/frames/geodetic2ecef.rst b/docs/source/frames/geodetic2ecef.rst
@@ -0,0 +1,4 @@
+geodetic2ecef
+=============
+
+.. autofunction:: ahrs.common.frames.geodetic2ecef
diff --git a/docs/source/frames/geodetic2enu.rst b/docs/source/frames/geodetic2enu.rst
@@ -0,0 +1,4 @@
+geodetic2enu
+============
+
+.. autofunction:: ahrs.common.frames.geodetic2enu
diff --git a/docs/source/geodesy.rst b/docs/source/geodesy.rst
@@ -3,8 +3,8 @@ Geodesy
 
 .. automodule:: ahrs.utils.geodesy
 
-Classes
--------
+Classes and Functions
+^^^^^^^^^^^^^^^^^^^^^
 
 .. toctree::
    :titlesonly:
@@ -13,11 +13,8 @@ Classes
    geodesy/wmm
    geodesy/wgs84
 
-Functions
----------
-
-Additionally, the library provides a set of functions that have been used
-historically in geodesy.
+Additionally, the library provides a set of methods that have been used
+historically in geodesy, but are not part of the above impllementations.
 
 .. toctree::
    :maxdepth: 1
@@ -27,11 +24,14 @@ historically in geodesy.
 
 .. automodule:: ahrs.common.frames
 
-Frame Transformations
----------------------
+The most common **reference frames transformations** used in geodesy are also
+implemented in the library.
 
 .. toctree::
    :maxdepth: 1
 
    frames/ecef2enu
    frames/enu2ecef
+   frames/ecef2geodetic
+   frames/geodetic2ecef
+   frames/geodetic2enu