From 50fb68ec5388a69a5f043e2478a5d3d1ab334fb9 Mon Sep 17 00:00:00 2001 From: ahmedk <karim.ahmed@xfel.eu> Date: Wed, 12 Oct 2022 16:35:10 +0200 Subject: [PATCH] Expose calcat_interface in the docs --- docs/source/calcat_interface.rst | 34 ++++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 35 insertions(+) create mode 100644 docs/source/calcat_interface.rst diff --git a/docs/source/calcat_interface.rst b/docs/source/calcat_interface.rst new file mode 100644 index 000000000..e9ba50289 --- /dev/null +++ b/docs/source/calcat_interface.rst @@ -0,0 +1,34 @@ +CALCAT Interface +================ + + +.. class:: CCVMetadata + +.. class:: CalCatError + +.. class:: ClientWrapper + +.. class:: CalCatApi + +.. class:: CalibrationData + + .. attribute:: metadata + + .. attribute:: ndarray + + .. attribute:: ndarray_map + +.. class:: SplitConditionCalibrationData + +.. class:: LPD_CalibrationData + +.. class:: DSSC_CalibrationData + +.. class:: JUNGFRAU_CalibrationData + +.. class:: PNCCD_CalibrationData + +.. class:: EPIX100_CalibrationData + +.. class:: GOTTHARD2_CalibrationData + diff --git a/docs/source/index.rst b/docs/source/index.rst index b57a68dee..d45ed2e41 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -57,6 +57,7 @@ Documentation contents: xfel_calibrate_conf cal_tools_algorithms + calcat_interface .. toctree:: :caption: Development -- GitLab