Skip to content

Commit

Permalink
Update unreleased documentation (#817)
Browse files Browse the repository at this point in the history
* Update versions.json

* Deployed befc9f0 to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <github-actions-bot@example.com>
  • Loading branch information
github-actions[bot] and GitHub Actions Bot authored Oct 1, 2024
1 parent b0199c1 commit 41a93ae
Show file tree
Hide file tree
Showing 20 changed files with 2,349 additions and 2,093 deletions.
6 changes: 3 additions & 3 deletions versions/unreleased/api-ref/prefect/cli/worker/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13249,8 +13249,7 @@ <h2 id="prefect.cli.worker.start" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/cli/worker.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 52</span>
<span class="normal"> 53</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 53</span>
<span class="normal"> 54</span>
<span class="normal"> 55</span>
<span class="normal"> 56</span>
Expand Down Expand Up @@ -13435,7 +13434,8 @@ <h2 id="prefect.cli.worker.start" class="doc doc-heading">
<span class="normal">235</span>
<span class="normal">236</span>
<span class="normal">237</span>
<span class="normal">238</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@worker_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
<span class="normal">238</span>
<span class="normal">239</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@worker_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span>
<span class="n">worker_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
<span class="kc">None</span><span class="p">,</span>
Expand Down
88 changes: 66 additions & 22 deletions versions/unreleased/api-ref/prefect/deployments/runner/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -13281,10 +13281,10 @@ <h2 id="prefect.deployments.steps.core.StepExecutionError" class="doc doc-headin

<details class="quote">
<summary>Source code in <code>prefect/deployments/steps/core.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">36</span>
<span class="normal">37</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">37</span>
<span class="normal">38</span>
<span class="normal">39</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">StepExecutionError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="normal">39</span>
<span class="normal">40</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">StepExecutionError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Raised when a step fails to execute.</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -13319,13 +13319,7 @@ <h2 id="prefect.deployments.steps.core.run_step" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/deployments/steps/core.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 95</span>
<span class="normal"> 96</span>
<span class="normal"> 97</span>
<span class="normal"> 98</span>
<span class="normal"> 99</span>
<span class="normal">100</span>
<span class="normal">101</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">101</span>
<span class="normal">102</span>
<span class="normal">103</span>
<span class="normal">104</span>
Expand All @@ -13352,7 +13346,13 @@ <h2 id="prefect.deployments.steps.core.run_step" class="doc doc-heading">
<span class="normal">125</span>
<span class="normal">126</span>
<span class="normal">127</span>
<span class="normal">128</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">async</span> <span class="k">def</span> <span class="nf">run_step</span><span class="p">(</span><span class="n">step</span><span class="p">:</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">upstream_outputs</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
<span class="normal">128</span>
<span class="normal">129</span>
<span class="normal">130</span>
<span class="normal">131</span>
<span class="normal">132</span>
<span class="normal">133</span>
<span class="normal">134</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">async</span> <span class="k">def</span> <span class="nf">run_step</span><span class="p">(</span><span class="n">step</span><span class="p">:</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">upstream_outputs</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Runs a step, returns the step&#39;s output.</span>

Expand Down
Loading

0 comments on commit 41a93ae

Please sign in to comment.