Skip to content

Commit

Permalink
Deployed 5bc02d6 to latest with MkDocs 1.5.3 and mike 2.1.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Mar 22, 2024
1 parent 75da393 commit 37c22fe
Show file tree
Hide file tree
Showing 8 changed files with 220 additions and 90 deletions.
2 changes: 1 addition & 1 deletion latest/common/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2182,7 +2182,7 @@ <h3 id="caret_analyze.common.UniqueList.__init__" class="doc doc-heading">
<tr>
<td><code>init</code></td>
<td>
<code><span title="typing.Any">Any</span></code>
<code><span title="collections.abc.Iterable">Iterable</span>[<span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
Expand Down
32 changes: 16 additions & 16 deletions latest/plot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1470,9 +1470,9 @@ <h3 id="caret_analyze.plot.Plot.create_frequency_histogram_plot" class="doc doc-
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -1548,9 +1548,9 @@ <h3 id="caret_analyze.plot.Plot.create_frequency_timeseries_plot" class="doc doc
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -1626,9 +1626,9 @@ <h3 id="caret_analyze.plot.Plot.create_latency_histogram_plot" class="doc doc-he
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -1704,9 +1704,9 @@ <h3 id="caret_analyze.plot.Plot.create_latency_timeseries_plot" class="doc doc-h
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -1916,9 +1916,9 @@ <h3 id="caret_analyze.plot.Plot.create_period_histogram_plot" class="doc doc-hea
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -1994,9 +1994,9 @@ <h3 id="caret_analyze.plot.Plot.create_period_timeseries_plot" class="doc doc-he
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.CallbackBase" href="../runtime/#caret_analyze.runtime.CallbackBase">CallbackBase</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Communication" href="../runtime/#caret_analyze.runtime.Communication">Communication</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Publisher" href="../runtime/#caret_analyze.runtime.Publisher">Publisher</a> | <a class="autorefs autorefs-internal" title="caret_analyze.runtime.Subscription" href="../runtime/#caret_analyze.runtime.Subscription">Subscription</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -2072,9 +2072,9 @@ <h3 id="caret_analyze.plot.Plot.create_response_time_histogram_plot" class="doc
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.Path" href="../runtime/#caret_analyze.runtime.Path">Path</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.Path" href="../runtime/#caret_analyze.runtime.Path">Path</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -2272,9 +2272,9 @@ <h3 id="caret_analyze.plot.Plot.create_response_time_timeseries_plot" class="doc
</thead>
<tbody>
<tr>
<td><code>target_objects</code></td>
<td><code>*target_objects</code></td>
<td>
<code>Collection[<a class="autorefs autorefs-internal" title="caret_analyze.runtime.Path" href="../runtime/#caret_analyze.runtime.Path">Path</a>]</code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.runtime.Path" href="../runtime/#caret_analyze.runtime.Path">Path</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down
79 changes: 37 additions & 42 deletions latest/record/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3094,20 +3094,6 @@ <h3 id="caret_analyze.record.RecordInterface.merge" class="doc doc-heading">
<em>required</em>
</td>
</tr>
<tr>
<td><code>inplace</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>inplace record if true, otherwise false.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -3755,7 +3741,7 @@ <h3 id="caret_analyze.record.RecordsInterface.merge" class="doc doc-heading">
<tr>
<td><code>right_records</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="caret_analyze.record.interface.RecordInterface" href="#caret_analyze.record.RecordInterface">RecordInterface</a></code>
<code><a class="autorefs autorefs-internal" title="caret_analyze.record.interface.RecordsInterface" href="#caret_analyze.record.RecordsInterface">RecordsInterface</a></code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -3952,7 +3938,7 @@ <h3 id="caret_analyze.record.RecordsInterface.merge_sequential" class="doc doc-h
<tr>
<td><code>join_left_key</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
Expand All @@ -3966,7 +3952,7 @@ <h3 id="caret_analyze.record.RecordsInterface.merge_sequential" class="doc doc-h
<tr>
<td><code>join_right_key</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
Expand All @@ -3978,27 +3964,27 @@ <h3 id="caret_analyze.record.RecordsInterface.merge_sequential" class="doc doc-h
</td>
</tr>
<tr>
<td><code>how</code></td>
<td><code>columns</code></td>
<td>
<code>str</code>
<code>list[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>merge type. [inner/right/left/outer]</p>
<p>columns</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr>
<td><code>columns</code></td>
<td><code>how</code></td>
<td>
<code>list[str]</code>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>columns</p>
<p>merge type. [inner/right/left/outer]</p>
</div>
</td>
<td>
Expand All @@ -4008,11 +3994,30 @@ <h3 id="caret_analyze.record.RecordsInterface.merge_sequential" class="doc doc-h
</tbody>
</table>

<details class="records" open>
<summary>Records</summary>
<p>RecordsInterface
Merged records.</p>
</details>


<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code><a class="autorefs autorefs-internal" title="caret_analyze.record.interface.RecordsInterface" href="#caret_analyze.record.RecordsInterface">RecordsInterface</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Merged records.</p>
</div>
</td>
</tr>
</tbody>
</table>



<p><strong>Examples:</strong></p>
Expand Down Expand Up @@ -4416,7 +4421,7 @@ <h3 id="caret_analyze.record.RecordsInterface.sort" class="doc doc-heading">
<tr>
<td><code>sub_key</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -4674,7 +4679,7 @@ <h3 id="caret_analyze.record.ResponseTime.__init__" class="doc doc-heading">
<tr>
<td><code>columns</code></td>
<td>
<code>str | None</code>
<code>list[str] | None</code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -4716,13 +4721,13 @@ <h3 id="caret_analyze.record.ResponseTime.to_all_records" class="doc doc-heading
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td></td> <td>
<td>
<code><a class="autorefs autorefs-internal" title="caret_analyze.record.interface.RecordsInterface" href="#caret_analyze.record.RecordsInterface">RecordsInterface</a></code>
</td>
<td>
Expand All @@ -4731,16 +4736,6 @@ <h3 id="caret_analyze.record.ResponseTime.to_all_records" class="doc doc-heading
</div>
</td>
</tr>
<tr>
<td><code>converter</code></td> <td>
<code>(<a class="autorefs autorefs-internal" title="caret_analyze.common.ClockConverter" href="../common/#caret_analyze.common.ClockConverter">ClockConverter</a> | None, optional)</code>
</td>
<td>
<div class="doc-md-description">
<p>Converter to simulation time.</p>
</div>
</td>
</tr>
</tbody>
</table>

Expand Down
68 changes: 65 additions & 3 deletions latest/runtime/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5247,9 +5247,9 @@ <h3 id="caret_analyze.runtime.Application.get_callbacks" class="doc doc-heading"
</thead>
<tbody>
<tr>
<td><code>callback_names</code></td>
<td><code>*callback_names</code></td>
<td>
<code>tuple[str, ...]</code>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -7625,6 +7625,36 @@ <h3 id="caret_analyze.runtime.CallbackGroup.get_callbacks" class="doc doc-headin



<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>*callback_names</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>callback names to get.</p>
</div>
</td>
<td>
<code>()</code>
</td>
</tr>
</tbody>
</table>



<p><strong>Returns:</strong></p>
<table>
<thead>
Expand Down Expand Up @@ -9278,6 +9308,36 @@ <h3 id="caret_analyze.runtime.Executor.get_callbacks" class="doc doc-heading">



<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>*callback_names</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>callback names to get.</p>
</div>
</td>
<td>
<code>()</code>
</td>
</tr>
</tbody>
</table>



<p><strong>Returns:</strong></p>
<table>
<thead>
Expand Down Expand Up @@ -10375,7 +10435,7 @@ <h3 id="caret_analyze.runtime.Node.get_callbacks" class="doc doc-heading">
</thead>
<tbody>
<tr>
<td><code>callback_names</code></td>
<td><code>*callback_names</code></td>
<td>
<code>str</code>
</td>
Expand Down Expand Up @@ -12403,6 +12463,7 @@ <h3 id="caret_analyze.runtime.PathBase.to_dataframe" class="doc doc-heading">
<tr>
<td><code>remove_dropped</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
Expand All @@ -12416,6 +12477,7 @@ <h3 id="caret_analyze.runtime.PathBase.to_dataframe" class="doc doc-heading">
<tr>
<td><code>treat_drop_as_delay</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
Expand Down
2 changes: 1 addition & 1 deletion latest/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 37c22fe

Please sign in to comment.