chore: Update tidal model documentation structure

CNES · Jul 2, 2024 · 4d4bf19 · 4d4bf19
1 parent 7fad4a7
commit 4d4bf19
Show file tree

Hide file tree

Showing 13 changed files with 17 additions and 54 deletions.
diff --git a/docs/source/core.rst b/docs/source/core.rst
@@ -40,12 +40,12 @@ These objects provides a Python interface to interpolate the tidal models
 at the requested spatio-temporal coordinates.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    core/abstract
-   core/cartesian
-   core/lgp1
-   core/lgp2
+   core/tidal_model/cartesian
+   core/tidal_model/lgp1
+   core/tidal_model/lgp2
 
 Tidal Prediction
 ----------------

diff --git a/docs/source/core/abstract.rst b/docs/source/core/abstract.rst
@@ -1,5 +1,5 @@
-pyfes.core.AbstractTidalModelComplex64
-======================================
+Abstract classes
+================
 
 .. currentmodule:: pyfes.core
 
@@ -10,12 +10,14 @@ pyfes.core.AbstractTidalModelComplex64
 
     .. automethod:: __init__
 
-pyfes.core.AbstractTidalModelComplex128
-=======================================
-
 .. autoclass:: AbstractTidalModelComplex128
     :show-inheritance:
     :members:
     :inherited-members:
 
     .. automethod:: __init__
+
+.. autoclass:: Accelerator
+    :show-inheritance:
+    :members:
+    :inherited-members:
diff --git a/docs/source/core/astronomic_angle.rst b/docs/source/core/astronomic_angle.rst
@@ -1,6 +1,3 @@
-pyfes.core.AstronomicAngle
-==========================
-
 .. currentmodule:: pyfes.core
 
 .. autoclass:: AstronomicAngle

diff --git a/docs/source/core/constituent.rst b/docs/source/core/constituent.rst
@@ -1,6 +1,3 @@
-pyfes.core.Constituent
-======================
-
 .. currentmodule:: pyfes.core
 
 .. class:: Constituent

diff --git a/docs/source/core/formulae.rst b/docs/source/core/formulae.rst
@@ -1,6 +1,3 @@
-pyfes.core.Formulae
-===================
-
 .. currentmodule:: pyfes.core
 
 .. class:: Formulae

diff --git a/docs/source/core/quality.rst b/docs/source/core/quality.rst
@@ -1,6 +1,3 @@
-pyfes.core.Quality
-==================
-
 .. currentmodule:: pyfes.core
 
 .. class:: Quality

diff --git a/docs/source/core/cartesian.rst → docs/source/core/tidal_model/cartesian.rst b/docs/source/core/cartesian.rst → docs/source/core/tidal_model/cartesian.rst
@@ -1,5 +1,5 @@
-pyfes.core.Axis
-===============
+Cartesian models
+================
 
 .. currentmodule:: pyfes.core
 
@@ -11,27 +11,18 @@ pyfes.core.Axis
 
     .. automethod:: __init__
 
-
-pyfes.core.tidal_model.CartesianComplex64
-=========================================
-
 .. currentmodule:: pyfes.core.tidal_model
 
 .. autoclass:: CartesianComplex64
     :show-inheritance:
     :members:
     :inherited-members:
 
-
     .. automethod:: __init__
 
-pyfes.core.tidal_model.CartesianComplex128
-==========================================
-
 .. autoclass:: CartesianComplex128
     :show-inheritance:
     :members:
     :inherited-members:
 
-
     .. automethod:: __init__
diff --git a/docs/source/core/lgp1.rst → docs/source/core/tidal_model/lgp1.rst b/docs/source/core/lgp1.rst → docs/source/core/tidal_model/lgp1.rst
@@ -1,5 +1,5 @@
-pyfes.core.tidal_model.LGP1Complex64
-====================================
+LPGP1 models
+============
 
 .. currentmodule:: pyfes.core.tidal_model
 
@@ -10,9 +10,6 @@ pyfes.core.tidal_model.LGP1Complex64
 
     .. automethod:: __init__
 
-pyfes.core.tidal_model.LGP1Complex128
-=====================================
-
 .. autoclass:: LGP1Complex128
     :show-inheritance:
     :members:

diff --git a/docs/source/core/lgp2.rst → docs/source/core/tidal_model/lgp2.rst b/docs/source/core/lgp2.rst → docs/source/core/tidal_model/lgp2.rst
@@ -1,5 +1,5 @@
-pyfes.core.tidal_model.LGP2Complex64
-====================================
+LGP2 models
+===========
 
 .. currentmodule:: pyfes.core.tidal_model
 
@@ -10,9 +10,6 @@ pyfes.core.tidal_model.LGP2Complex64
 
     .. automethod:: __init__
 
-pyfes.core.tidal_model.LGP2Complex128
-=====================================
-
 .. autoclass:: LGP2Complex128
     :show-inheritance:
     :members:

diff --git a/docs/source/core/tide.rst b/docs/source/core/tide.rst
@@ -1,6 +1,3 @@
-pyfes.core.evaluate_tide
-========================
-
 .. py:function:: pyfes.core.evaluate_tide(\
         tidal_model: Union[pyfes.core.AbstractTidalModelComplex64, \
                             pyfes.core.AbstractTidalModelComplex128], \

diff --git a/docs/source/core/tide_type.rst b/docs/source/core/tide_type.rst
@@ -1,6 +1,3 @@
-pyfes.core.TideType
-===================
-
 .. automodule:: pyfes.core
 
 .. class:: TideType

diff --git a/docs/source/core/wave.rst b/docs/source/core/wave.rst
@@ -1,6 +1,3 @@
-pyfes.core.Wave
-===============
-
 .. currentmodule:: pyfes.core
 
 .. autoclass:: Wave

diff --git a/docs/source/core/wave_table.rst b/docs/source/core/wave_table.rst
@@ -1,6 +1,3 @@
-pyfes.core.WaveTable
-====================
-
 .. currentmodule:: pyfes.core
 
 .. autoclass:: WaveTable