Skip to content

Commit 868e3d6

Browse files
committed
update kima API
1 parent d1b78f0 commit 868e3d6

File tree

1 file changed

+3
-31
lines changed

1 file changed

+3
-31
lines changed

Diff for: docs/docs/API/kima.md

+3-31
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ data = RVData('filename.txt', skip=1)
2222
::: kima.Data.RVData
2323
handler: python
2424
options:
25-
show_signature_annotations: false
26-
members_order: source
27-
heading_level: 5
2825
filters:
2926
- "!__"
3027
- "__init__"
@@ -46,9 +43,6 @@ model = RVmodel(fix=False, npmax=2, data=data)
4643
::: kima.RVmodel
4744
handler: python
4845
options:
49-
docstring_style: "google"
50-
heading_level: 5
51-
merge_init_into_class: true
5246
filters:
5347
- "!RVConditionalPrior"
5448
- "!TRANSITConditionalPrior"
@@ -61,7 +55,6 @@ model = RVmodel(fix=False, npmax=2, data=data)
6155
::: kima.GPmodel
6256
handler: python
6357
options:
64-
heading_level: 5
6558
filters:
6659
- "!RVConditionalPrior"
6760
- "!TRANSITConditionalPrior"
@@ -73,7 +66,6 @@ model = RVmodel(fix=False, npmax=2, data=data)
7366
::: kima.RVFWHMmodel
7467
handler: python
7568
options:
76-
heading_level: 5
7769
filters:
7870
- "!RVConditionalPrior"
7971
- "!TRANSITConditionalPrior"
@@ -85,7 +77,6 @@ model = RVmodel(fix=False, npmax=2, data=data)
8577
::: kima.BINARIESmodel
8678
handler: python
8779
options:
88-
heading_level: 5
8980
filters:
9081
- "!RVConditionalPrior"
9182
- "!TRANSITConditionalPrior"
@@ -157,38 +148,19 @@ parameter_prior = distributions.Gaussian(10, 1)
157148
- "!upper"
158149
- "!__" -->
159150

160-
<!--
161-
show_docstring_functions
162-
show_docstring_modules
163-
show_docstring_examples
164-
show_docstring_raises
165-
show_docstring_receives
166-
show_docstring_returns
167-
show_docstring_warns
168-
show_docstring_yields
169-
-->
170-
<!-- show_root_toc_entry: true
171-
show_docstring_description: false
172-
show_docstring_attributes: false
173-
174-
show_properties: false
175-
heading_level: 4
176-
-->
177-
178-
???+ example "`kima.distributions` API"
151+
152+
??? example "`kima.distributions` API"
179153

180154
::: kima.distributions
181155
handler: python
182156
options:
183157
show_root_heading: false
184-
show_root_toc_entry: false
185158
show_bases: false
186-
show_labels: true
187-
heading_level: 6
188159
filters:
189160
- "!__"
190161
- "!Distribution"
191162

163+
### Keplerian
192164

193165
Finally, even though it sits at the core of what **kima** does,
194166
there is the [keplerian][kima.kepler.keplerian] function:

0 commit comments

Comments
 (0)