Skip to content

Commit 8e4646c

Browse files
Ensure mkdocs-build does not run on main (#223)
## Description Ensure mkdocs-build does not run on main ## Checklist - [x] I have read the contributing guide and the code of conduct --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent f6f04be commit 8e4646c

2 files changed

Lines changed: 81 additions & 0 deletions

File tree

.github/workflows/mkdocs-build.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ name: Build and Commit MkDocs Documentation
22

33
on:
44
push:
5+
branches-ignore:
6+
- main
7+
pull_request:
58

69
concurrency:
710
group: ${{ github.workflow }}-${{ github.ref }}

mkdocs/site/packages/evo-blockmodels.html

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,84 @@ <h3 id="evo.blockmodels.client.BlockModelAPIClient.list_block_models" class="doc
415415
<div class="doc doc-object doc-function">
416416

417417

418+
<h3 id="evo.blockmodels.client.BlockModelAPIClient.get_block_model" class="doc doc-heading">
419+
<span class="doc doc-object-name doc-function-name">get_block_model</span>
420+
421+
422+
<span class="doc doc-labels">
423+
<small class="doc doc-label doc-label-async"><code>async</code></small>
424+
</span>
425+
426+
</h3>
427+
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_block_model</span><span class="p">(</span><span class="n">bm_id</span><span class="p">:</span> <span class="n">UUID</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BlockModel</span>
428+
</code></pre></div>
429+
430+
<div class="doc doc-contents ">
431+
432+
<p>Get a block model by ID.</p>
433+
434+
435+
<p><span class="doc-section-title">Parameters:</span></p>
436+
<table>
437+
<thead>
438+
<tr>
439+
<th>Name</th>
440+
<th>Type</th>
441+
<th>Description</th>
442+
<th>Default</th>
443+
</tr>
444+
</thead>
445+
<tbody>
446+
<tr class="doc-section-item">
447+
<td>
448+
<code>bm_id</code>
449+
</td>
450+
<td>
451+
<code><span title="uuid.UUID">UUID</span></code>
452+
</td>
453+
<td>
454+
<div class="doc-md-description">
455+
<p>The ID of the block model to retrieve.</p>
456+
</div>
457+
</td>
458+
<td>
459+
<em>required</em>
460+
</td>
461+
</tr>
462+
</tbody>
463+
</table>
464+
465+
466+
<p><span class="doc-section-title">Returns:</span></p>
467+
<table>
468+
<thead>
469+
<tr>
470+
<th>Type</th>
471+
<th>Description</th>
472+
</tr>
473+
</thead>
474+
<tbody>
475+
<tr class="doc-section-item">
476+
<td>
477+
<code><span title="evo.blockmodels.data.BlockModel">BlockModel</span></code>
478+
</td>
479+
<td>
480+
<div class="doc-md-description">
481+
<p>The BlockModel metadata.</p>
482+
</div>
483+
</td>
484+
</tr>
485+
</tbody>
486+
</table>
487+
488+
489+
</div>
490+
491+
</div>
492+
493+
<div class="doc doc-object doc-function">
494+
495+
418496
<h3 id="evo.blockmodels.client.BlockModelAPIClient.list_all_block_models" class="doc doc-heading">
419497
<span class="doc doc-object-name doc-function-name">list_all_block_models</span>
420498

0 commit comments

Comments
 (0)