FIX: doc build

cerfacs-globc · Feb 29, 2024 · 69e454b · 69e454b
1 parent 72b4e31
commit 69e454b
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 9 deletions.
diff --git a/doc/source/references/dcsc_functions_api.rst b/doc/source/references/dcsc_functions_api.rst
@@ -20,7 +20,7 @@ Usage
  DCSC Generated Functions
 **************************
 
-.. automodule:: icclim._generated_api
+.. automodule:: icclim._generated._dcsc
    :members:
    :no-index:
 

diff --git a/doc/source/references/ecad_functions_api.rst b/doc/source/references/ecad_functions_api.rst
@@ -6,7 +6,7 @@
 
 icclim 5.2 comes with convenience functions to call each individual
 index from `icclim` namespace. These functions are autogenerated and are
-stored in `_generated_api.py`. Additionally, user custom indices can be
+stored in `_generated/_ecad.py`. Additionally, user custom indices can be
 called with the `icclim.custom_index`.
 
 For example to use this new API with the index `su` you can do:
@@ -22,7 +22,7 @@ For example to use this new API with the index `su` you can do:
  ECAD Generated Functions
 **************************
 
-.. automodule:: icclim._generated_api
+.. automodule:: icclim._generated._ecad
    :members:
    :no-index:
 

diff --git a/doc/source/references/generic_functions_api.rst b/doc/source/references/generic_functions_api.rst
@@ -32,7 +32,7 @@ capabilities of these generic indices.
  Generated API
 ***************
 
-.. automodule:: icclim._generated_api
+.. automodule:: icclim._generated._generic
    :members:
 
    .. rubric:: Functions

diff --git a/doc/source/references/index.rst b/doc/source/references/index.rst
@@ -15,6 +15,7 @@ mechanisms of icclim.
 
    icclim_index_api
    ecad_functions_api
+   dcsc_functions_api
    generic_functions_api
    custom_indices
    frequency

diff --git a/doc/source/references/threshold.rst b/doc/source/references/threshold.rst
@@ -2,7 +2,7 @@
 Threshold
 #########
 
-.. automodule:: icclim.generic_indices.threshold
+.. automodule:: icclim.generic_indices.thresholds.factory
     :members:
 
     .. rubric:: Functions
@@ -13,8 +13,26 @@ Threshold
 
     .. rubric:: Classes
 
+.. automodule:: icclim.generic_indices.thresholds.models
+
     .. autosummary::
+
         Threshold
+
+.. automodule:: icclim.generic_indices.thresholds.basic
+
+    .. autosummary::
+
         BasicThreshold
+
+.. automodule:: icclim.generic_indices.thresholds.percentile
+
+    .. autosummary::
+
         PercentileThreshold
+
+.. automodule:: icclim.generic_indices.thresholds.bounded
+
+    .. autosummary::
+
         BoundedThreshold
diff --git a/src/icclim/generic_indices/thresholds/factory.py b/src/icclim/generic_indices/thresholds/factory.py
@@ -123,10 +123,7 @@ def build_threshold(
 
         # -- Per grid-cell threshold, with offset
         grided_t = build_threshold(
-            operator=">=",
-            value="path/to/tasmax_thresholds.nc",
-            unit="K"
-            offset = 5
+            operator=">=", value="path/to/tasmax_thresholds.nc", unit="K", offset=5
         )
         assert isinstance(grided_t, BasicThreshold)