Skip to content

Commit b371fa2

Browse files
committed
deploy: 13d4e55
1 parent ee7bbd8 commit b371fa2

17 files changed

Lines changed: 302 additions & 292 deletions

File tree

404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515

1616
<link rel="icon" href="/cellengine-python-toolkit/images/favicon.ico">
17-
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
17+
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-7.3.6">
1818

1919

2020

api_client/index.html

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<link rel="canonical" href="https://cellengine.github.io/cellengine-python-toolkit/api_client/">
1717

1818
<link rel="icon" href="../images/favicon.ico">
19-
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
19+
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-7.3.6">
2020

2121

2222

@@ -1615,7 +1615,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16151615

16161616

16171617

1618-
<p><strong>Parameters:</strong></p>
1618+
<p><span class="doc-section-title">Parameters:</span></p>
16191619
<table>
16201620
<thead>
16211621
<tr>
@@ -1626,7 +1626,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16261626
</tr>
16271627
</thead>
16281628
<tbody>
1629-
<tr>
1629+
<tr class="doc-section-item">
16301630
<td><code>experiment_id</code></td>
16311631
<td>
16321632
<code>str</code>
@@ -1640,7 +1640,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16401640
<em>required</em>
16411641
</td>
16421642
</tr>
1643-
<tr>
1643+
<tr class="doc-section-item">
16441644
<td><code>_id</code></td>
16451645
<td>
16461646
<code><span title="typing.Optional">Optional</span>[str]</code>
@@ -1654,7 +1654,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16541654
<code>None</code>
16551655
</td>
16561656
</tr>
1657-
<tr>
1657+
<tr class="doc-section-item">
16581658
<td><code>gid</code></td>
16591659
<td>
16601660
<code><span title="typing.Optional">Optional</span>[str]</code>
@@ -1668,7 +1668,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16681668
<code>None</code>
16691669
</td>
16701670
</tr>
1671-
<tr>
1671+
<tr class="doc-section-item">
16721672
<td><code>exclude</code></td>
16731673
<td>
16741674
<code><span title="typing.Optional">Optional</span>[str]</code>
@@ -1695,7 +1695,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
16951695
</details>
16961696

16971697

1698-
<p><strong>Returns:</strong></p>
1698+
<p><span class="doc-section-title">Returns:</span></p>
16991699
<table>
17001700
<thead>
17011701
<tr>
@@ -1704,7 +1704,7 @@ <h3 id="cellengine.APIClient.delete_gate" class="doc doc-heading">
17041704
</tr>
17051705
</thead>
17061706
<tbody>
1707-
<tr>
1707+
<tr class="doc-section-item">
17081708
<td>
17091709
<code>None</code>
17101710
</td>
@@ -1774,7 +1774,7 @@ <h3 id="cellengine.APIClient.download_fcs_file" class="doc doc-heading">
17741774

17751775

17761776

1777-
<p><strong>Parameters:</strong></p>
1777+
<p><span class="doc-section-title">Parameters:</span></p>
17781778
<table>
17791779
<thead>
17801780
<tr>
@@ -1785,7 +1785,7 @@ <h3 id="cellengine.APIClient.download_fcs_file" class="doc doc-heading">
17851785
</tr>
17861786
</thead>
17871787
<tbody>
1788-
<tr>
1788+
<tr class="doc-section-item">
17891789
<td><code>experiment_id</code></td>
17901790
<td>
17911791
<code>str</code>
@@ -1799,7 +1799,7 @@ <h3 id="cellengine.APIClient.download_fcs_file" class="doc doc-heading">
17991799
<em>required</em>
18001800
</td>
18011801
</tr>
1802-
<tr>
1802+
<tr class="doc-section-item">
18031803
<td><code>fcs_file_id</code></td>
18041804
<td>
18051805
<code>str</code>
@@ -1813,7 +1813,7 @@ <h3 id="cellengine.APIClient.download_fcs_file" class="doc doc-heading">
18131813
<em>required</em>
18141814
</td>
18151815
</tr>
1816-
<tr>
1816+
<tr class="doc-section-item">
18171817
<td><code>**kwargs</code></td>
18181818
<td>
18191819
<code><span title="typing.Any">Any</span></code>
@@ -2172,7 +2172,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
21722172

21732173

21742174

2175-
<p><strong>Parameters:</strong></p>
2175+
<p><span class="doc-section-title">Parameters:</span></p>
21762176
<table>
21772177
<thead>
21782178
<tr>
@@ -2183,7 +2183,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
21832183
</tr>
21842184
</thead>
21852185
<tbody>
2186-
<tr>
2186+
<tr class="doc-section-item">
21872187
<td><code>experiment_id</code></td>
21882188
<td>
21892189
<code>str</code>
@@ -2197,7 +2197,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
21972197
<em>required</em>
21982198
</td>
21992199
</tr>
2200-
<tr>
2200+
<tr class="doc-section-item">
22012201
<td><code>statistics</code></td>
22022202
<td>
22032203
<code><span title="typing.List">List</span>[str]</code>
@@ -2213,7 +2213,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22132213
<em>required</em>
22142214
</td>
22152215
</tr>
2216-
<tr>
2216+
<tr class="doc-section-item">
22172217
<td><code>q</code></td>
22182218
<td>
22192219
<code>int</code>
@@ -2227,7 +2227,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22272227
<code>None</code>
22282228
</td>
22292229
</tr>
2230-
<tr>
2230+
<tr class="doc-section-item">
22312231
<td><code>channels</code></td>
22322232
<td>
22332233
<code><span title="typing.List">List</span>[str]</code>
@@ -2243,7 +2243,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22432243
<em>required</em>
22442244
</td>
22452245
</tr>
2246-
<tr>
2246+
<tr class="doc-section-item">
22472247
<td><code>annotations</code></td>
22482248
<td>
22492249
<code>bool</code>
@@ -2258,7 +2258,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22582258
<code>False</code>
22592259
</td>
22602260
</tr>
2261-
<tr>
2261+
<tr class="doc-section-item">
22622262
<td><code>compensation_id</code></td>
22632263
<td>
22642264
<code><span title="typing.Union">Union</span>[<span title="cellengine.resources.compensation.Compensations">Compensations</span>, str]</code>
@@ -2277,7 +2277,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22772277
<code><a class="autorefs autorefs-internal" title="cellengine.resources.compensation.UNCOMPENSATED" href="../compensations/#cellengine.UNCOMPENSATED">UNCOMPENSATED</a></code>
22782278
</td>
22792279
</tr>
2280-
<tr>
2280+
<tr class="doc-section-item">
22812281
<td><code>fcs_file_ids</code></td>
22822282
<td>
22832283
<code><span title="typing.Optional">Optional</span>[<span title="typing.List">List</span>[str]]</code>
@@ -2292,7 +2292,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
22922292
<code>None</code>
22932293
</td>
22942294
</tr>
2295-
<tr>
2295+
<tr class="doc-section-item">
22962296
<td><code>format</code></td>
22972297
<td>
22982298
<code>str</code>
@@ -2308,7 +2308,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23082308
<code>&#39;json&#39;</code>
23092309
</td>
23102310
</tr>
2311-
<tr>
2311+
<tr class="doc-section-item">
23122312
<td><code>layout</code></td>
23132313
<td>
23142314
<code><span title="typing.Optional">Optional</span>[str]</code>
@@ -2323,7 +2323,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23232323
<code>None</code>
23242324
</td>
23252325
</tr>
2326-
<tr>
2326+
<tr class="doc-section-item">
23272327
<td><code>percent_of</code></td>
23282328
<td>
23292329
<code><span title="typing.Optional">Optional</span>[<span title="typing.Union">Union</span>[str, <span title="typing.List">List</span>[str]]]</code>
@@ -2342,7 +2342,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23422342
<code>&#39;PARENT&#39;</code>
23432343
</td>
23442344
</tr>
2345-
<tr>
2345+
<tr class="doc-section-item">
23462346
<td><code>population_ids</code></td>
23472347
<td>
23482348
<code><span title="typing.Optional">Optional</span>[<span title="typing.List">List</span>[str]]</code>
@@ -2362,7 +2362,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23622362

23632363

23642364

2365-
<p><strong>Returns:</strong></p>
2365+
<p><span class="doc-section-title">Returns:</span></p>
23662366
<table>
23672367
<thead>
23682368
<tr>
@@ -2371,7 +2371,7 @@ <h3 id="cellengine.APIClient.get_statistics" class="doc doc-heading">
23712371
</tr>
23722372
</thead>
23732373
<tbody>
2374-
<tr>
2374+
<tr class="doc-section-item">
23752375
<td><code>statistics</code></td> <td>
23762376
<code><span title="typing.Union">Union</span>[<span title="typing.Dict">Dict</span>, str, <span title="pandas.core.frame.DataFrame">DataFrame</span>]</code>
23772377
</td>
@@ -2579,7 +2579,7 @@ <h3 id="cellengine.APIClient.upload_attachment" class="doc doc-heading">
25792579

25802580

25812581

2582-
<p><strong>Parameters:</strong></p>
2582+
<p><span class="doc-section-title">Parameters:</span></p>
25832583
<table>
25842584
<thead>
25852585
<tr>
@@ -2590,7 +2590,7 @@ <h3 id="cellengine.APIClient.upload_attachment" class="doc doc-heading">
25902590
</tr>
25912591
</thead>
25922592
<tbody>
2593-
<tr>
2593+
<tr class="doc-section-item">
25942594
<td><code>filepath</code></td>
25952595
<td>
25962596
<code>str</code>
@@ -2604,7 +2604,7 @@ <h3 id="cellengine.APIClient.upload_attachment" class="doc doc-heading">
26042604
<em>required</em>
26052605
</td>
26062606
</tr>
2607-
<tr>
2607+
<tr class="doc-section-item">
26082608
<td><code>filename</code></td>
26092609
<td>
26102610
<code>str</code>
@@ -2623,7 +2623,7 @@ <h3 id="cellengine.APIClient.upload_attachment" class="doc doc-heading">
26232623

26242624

26252625

2626-
<p><strong>Returns:</strong></p>
2626+
<p><span class="doc-section-title">Returns:</span></p>
26272627
<table>
26282628
<thead>
26292629
<tr>
@@ -2632,7 +2632,7 @@ <h3 id="cellengine.APIClient.upload_attachment" class="doc doc-heading">
26322632
</tr>
26332633
</thead>
26342634
<tbody>
2635-
<tr>
2635+
<tr class="doc-section-item">
26362636
<td>
26372637
<code><a class="autorefs autorefs-internal" title="cellengine.resources.attachment.Attachment" href="../attachments/#cellengine.resources.attachment.Attachment">Attachment</a></code>
26382638
</td>
@@ -2666,7 +2666,7 @@ <h3 id="cellengine.APIClient.upload_fcs_file" class="doc doc-heading">
26662666

26672667

26682668

2669-
<p><strong>Parameters:</strong></p>
2669+
<p><span class="doc-section-title">Parameters:</span></p>
26702670
<table>
26712671
<thead>
26722672
<tr>
@@ -2677,7 +2677,7 @@ <h3 id="cellengine.APIClient.upload_fcs_file" class="doc doc-heading">
26772677
</tr>
26782678
</thead>
26792679
<tbody>
2680-
<tr>
2680+
<tr class="doc-section-item">
26812681
<td><code>filepath_or_data</code></td>
26822682
<td>
26832683
<code><span title="typing.Union">Union</span>[str, <span title="io.BytesIO">BytesIO</span>]</code>
@@ -2691,7 +2691,7 @@ <h3 id="cellengine.APIClient.upload_fcs_file" class="doc doc-heading">
26912691
<em>required</em>
26922692
</td>
26932693
</tr>
2694-
<tr>
2694+
<tr class="doc-section-item">
26952695
<td><code>filename</code></td>
26962696
<td>
26972697
<code><span title="typing.Optional">Optional</span>[str]</code>
@@ -2710,7 +2710,7 @@ <h3 id="cellengine.APIClient.upload_fcs_file" class="doc doc-heading">
27102710

27112711

27122712

2713-
<p><strong>Returns:</strong></p>
2713+
<p><span class="doc-section-title">Returns:</span></p>
27142714
<table>
27152715
<thead>
27162716
<tr>
@@ -2719,7 +2719,7 @@ <h3 id="cellengine.APIClient.upload_fcs_file" class="doc doc-heading">
27192719
</tr>
27202720
</thead>
27212721
<tbody>
2722-
<tr>
2722+
<tr class="doc-section-item">
27232723
<td>
27242724
<code><a class="autorefs autorefs-internal" title="cellengine.resources.fcs_file.FcsFile" href="../fcs_files/#cellengine.resources.fcs_file.FcsFile">FcsFile</a></code>
27252725
</td>

assets/_mkdocstrings.css

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@
2626
float: right;
2727
}
2828

29+
/* Backward-compatibility: docstring section titles in bold. */
30+
.doc-section-title {
31+
font-weight: bold;
32+
}
33+
2934
/* Symbols in Navigation and ToC. */
3035
:root,
3136
[data-md-color-scheme="default"] {
@@ -106,4 +111,9 @@ code.doc-symbol-module {
106111

107112
code.doc-symbol-module::after {
108113
content: "mod";
109-
}
114+
}
115+
116+
.doc-signature .autorefs {
117+
color: inherit;
118+
border-bottom: 1px dotted currentcolor;
119+
}

0 commit comments

Comments
 (0)