From cb5e89c47ef34b2ede04a66d8281042f5f3d9c9c Mon Sep 17 00:00:00 2001 From: Aron Mirwald Date: Fri, 21 Jun 2024 15:02:27 +0200 Subject: [PATCH] include Catalog methods in docs --- docs/source/reference/catalog.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/source/reference/catalog.md b/docs/source/reference/catalog.md index bb44810..1780939 100644 --- a/docs/source/reference/catalog.md +++ b/docs/source/reference/catalog.md @@ -13,11 +13,35 @@ Catalog ``` -## Transformation +## Modify Catalog ```{eval-rst} .. autosummary:: :toctree: api/ Catalog.bin_magnitudes + Catalog.strip + Catalog.drop_ids + Catalog.drop_uncertainties +``` + +## Estimate from Catalog + +```{eval-rst} +.. autosummary:: + :toctree: api/ + + Catalog.estimate_b + Catalog.estimate_mc +``` + +## Transform from or to other format + +```{eval-rst} +.. autosummary:: + :toctree: api/ + + Catalog.to_quakeml + Catalog.from_quakeml + Catalog.from_dict ``` \ No newline at end of file