Include interpolation in docs

cta-observatory · Sep 10, 2024 · 282e850 · 282e850
1 parent 7532b6e
commit 282e850
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 9 deletions.
diff --git a/docs/api-reference/monitoring/index.rst b/docs/api-reference/monitoring/index.rst
@@ -18,9 +18,9 @@ Submodules
 
 .. toctree::
   :maxdepth: 1
-  :glob:
 
   aggregator
+  interpolation
   outlier
 
 

diff --git a/docs/api-reference/monitoring/interpolation.rst b/docs/api-reference/monitoring/interpolation.rst
@@ -0,0 +1,11 @@
+.. _monitoring_interpolation:
+
+*************
+Interpolation
+*************
+
+
+Reference/API
+=============
+
+.. automodapi:: ctapipe.monitoring.interpolation
diff --git a/src/ctapipe/io/__init__.py b/src/ctapipe/io/__init__.py
@@ -18,11 +18,6 @@
 
 from .datawriter import DATA_MODEL_VERSION, DataWriter
 
-from .interpolation import (
-    Interpolator,
-    PointingInterpolator,
-)
-
 __all__ = [
     "HDF5TableWriter",
     "HDF5TableReader",
@@ -40,6 +35,4 @@
     "DataWriter",
     "DATA_MODEL_VERSION",
     "get_hdf5_datalevels",
-    "Interpolator",
-    "PointingInterpolator",
 ]
diff --git a/src/ctapipe/monitoring/interpolation.py b/src/ctapipe/monitoring/interpolation.py
@@ -9,7 +9,10 @@
 
 from ctapipe.core import Component, traits
 
-from .astropy_helpers import read_table
+__all__ = [
+    "Interpolator",
+    "PointingInterpolator",
+]
 
 
 class Interpolator(Component, metaclass=ABCMeta):
@@ -103,6 +106,9 @@ def _check_interpolators(self, tel_id):
                 raise KeyError(f"No table available for tel_id {tel_id}")
 
     def _read_parameter_table(self, tel_id):
+        # prevent circular import between io and monitoring
+        from ..io import read_table
+
         input_table = read_table(
             self.h5file,
             f"{self.telescope_data_group}/tel_{tel_id:03d}",