update docs for monitoring module

cta-observatory · Aug 1, 2024 · cde6857 · cde6857
1 parent 5a143dd
commit cde6857
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/docs/api-reference/monitoring/extractor.rst b/docs/api-reference/monitoring/extractor.rst
@@ -0,0 +1,11 @@
+.. _stats_extractor:
+
+********************
+Statistics Extractor
+********************
+
+
+Reference/API
+=============
+
+.. automodapi:: ctapipe.monitoring.extractor
diff --git a/docs/api-reference/monitoring/index.rst b/docs/api-reference/monitoring/index.rst
@@ -0,0 +1,28 @@
+.. _monitoring:
+
+**********************************
+Monitoring (`~ctapipe.monitoring`)
+**********************************
+
+.. currentmodule:: ctapipe.monitoring
+
+This module include all the functions and classes needed for the Monitoring of CTA data.
+
+Currently, only code related to :ref:`_stats_extractor` is implemented here.
+
+
+Submodules
+==========
+
+.. toctree::
+  :maxdepth: 1
+  :glob:
+
+  extractor
+
+
+Reference/API
+=============
+
+.. automodapi:: ctapipe.monitoring
+    :no-inheritance-diagram: