From 868e3d67ad1ca9efa1535ed325fac2d3e1934deb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Faria?= Date: Mon, 8 Jul 2024 15:26:44 +0200 Subject: [PATCH] update kima API --- docs/docs/API/kima.md | 34 +++------------------------------- 1 file changed, 3 insertions(+), 31 deletions(-) diff --git a/docs/docs/API/kima.md b/docs/docs/API/kima.md index 46cb245..4eefac6 100644 --- a/docs/docs/API/kima.md +++ b/docs/docs/API/kima.md @@ -22,9 +22,6 @@ data = RVData('filename.txt', skip=1) ::: kima.Data.RVData handler: python options: - show_signature_annotations: false - members_order: source - heading_level: 5 filters: - "!__" - "__init__" @@ -46,9 +43,6 @@ model = RVmodel(fix=False, npmax=2, data=data) ::: kima.RVmodel handler: python options: - docstring_style: "google" - heading_level: 5 - merge_init_into_class: true filters: - "!RVConditionalPrior" - "!TRANSITConditionalPrior" @@ -61,7 +55,6 @@ model = RVmodel(fix=False, npmax=2, data=data) ::: kima.GPmodel handler: python options: - heading_level: 5 filters: - "!RVConditionalPrior" - "!TRANSITConditionalPrior" @@ -73,7 +66,6 @@ model = RVmodel(fix=False, npmax=2, data=data) ::: kima.RVFWHMmodel handler: python options: - heading_level: 5 filters: - "!RVConditionalPrior" - "!TRANSITConditionalPrior" @@ -85,7 +77,6 @@ model = RVmodel(fix=False, npmax=2, data=data) ::: kima.BINARIESmodel handler: python options: - heading_level: 5 filters: - "!RVConditionalPrior" - "!TRANSITConditionalPrior" @@ -157,38 +148,19 @@ parameter_prior = distributions.Gaussian(10, 1) - "!upper" - "!__" --> - - - -???+ example "`kima.distributions` API" + +??? example "`kima.distributions` API" ::: kima.distributions handler: python options: show_root_heading: false - show_root_toc_entry: false show_bases: false - show_labels: true - heading_level: 6 filters: - "!__" - "!Distribution" +### Keplerian Finally, even though it sits at the core of what **kima** does, there is the [keplerian][kima.kepler.keplerian] function: