WIP update api

E3SM-Project · Oct 6, 2023 · 9f86ada · 9f86ada
1 parent 1d766ca
commit 9f86ada
Showing 1 changed file with 17 additions and 7 deletions.
diff --git a/docs/developers_guide/ocean/api.md b/docs/developers_guide/ocean/api.md
@@ -169,6 +169,23 @@
 
 ## Ocean Framework
 
+### Convergence Tests
+
+```{eval-rst}
+.. currentmodule:: polaris.ocean.convergence
+
+.. autosummary::
+   :toctree: generated/
+
+   ConvergenceForward
+   ConvergenceAnalysis
+   ConvergenceAnalysis.compute_error
+   ConvergenceAnalysis.convergence_parameters
+   ConvergenceAnalysis.exact_solution
+   ConvergenceAnalysis.get_output_field
+   ConvergenceAnalysis.run
+   ConvergenceAnalysis.plot_convergence
+```
 ### Spherical Convergence Tests
 
 ```{eval-rst}
@@ -178,13 +195,6 @@
    :toctree: generated/
 
    SphericalConvergenceForward
-   SphericalConvergenceAnalysis
-   SphericalConvergenceAnalysis.compute_error
-   SphericalConvergenceAnalysis.convergence_parameters
-   SphericalConvergenceAnalysis.exact_solution
-   SphericalConvergenceAnalysis.get_output_field
-   SphericalConvergenceAnalysis.run
-   SphericalConvergenceAnalysis.plot_convergence
 ```
 
 ### Ocean Model