Re-structure World Model position in documentation.

Mayitzin · Aug 22, 2023 · 197dea4 · 197dea4
1 parent 0820fcd
commit 197dea4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 9 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -79,29 +79,24 @@ Loading and visualizing the data is left to the preference of the user.
 
 .. toctree::
    :maxdepth: 1
-   :hidden:
 
    installation
 
 .. toctree::
    :maxdepth: 1
    :caption: Attitude Estimators
-   :hidden:
 
    filters
 
 .. toctree::
    :maxdepth: 1
    :caption: World Models
-   :hidden:
 
-   wmm
-   wgs84
+   world_models
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Tools
-   :hidden:
 
    attitude_representations
    constants

diff --git a/docs/source/wgs84.rst b/docs/source/wgs84.rst
@@ -1,4 +1,5 @@
+World Geodetic System (1984)
+============================
 
 .. automodule:: ahrs.utils.wgs84
    :members:
-   :exclude-members: WGSTest
diff --git a/docs/source/wmm.rst b/docs/source/wmm.rst
@@ -1,4 +1,5 @@
+World Magnetic Model
+====================
 
 .. automodule:: ahrs.utils.wmm
    :members:
-   :exclude-members: GeoMagTest
diff --git a/docs/source/world_models.rst b/docs/source/world_models.rst
@@ -0,0 +1,12 @@
+World Models
+============
+
+This package contains the tools necessary to obtain the values of the World
+Geodetic System 1984 (WGS84) parameters for a given location on the Earth's,
+and of the World Magnetic Model (WMM) parameters for a given location and time.
+
+.. toctree::
+   :titlesonly:
+
+   wmm
+   wgs84