Skip to content

Commit

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

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

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <[email protected]>
  • Loading branch information
@github-actions
github-actions[bot] and GitHub Actions Bot authored Jan 11, 2024
1 parent d59b357 commit 6561ede
Show file tree
Hide file tree
Showing 10 changed files with 327 additions and 210 deletions.
12 changes: 9 additions & 3 deletions versions/unreleased/api-ref/prefect/deployments/runner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12657,7 +12657,10 @@ <h2 id="prefect.deployments.runner.deploy" class="doc doc-heading">
<span class="normal">923</span>
<span class="normal">924</span>
<span class="normal">925</span>
<span class="normal">926</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<span class="normal">926</span>
<span class="normal">927</span>
<span class="normal">928</span>
<span class="normal">929</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@sync_compatible</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">deploy</span><span class="p">(</span>
<span class="o">*</span><span class="n">deployments</span><span class="p">:</span> <span class="n">RunnerDeployment</span><span class="p">,</span>
<span class="n">work_pool_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -12754,8 +12757,11 @@ <h2 id="prefect.deployments.runner.deploy" class="doc doc-heading">
<span class="c1"># carve out an exception for block based work pools that only have a block in their base job template</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_docker_based_work_pool</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">is_block_based_work_pool</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Work pool </span><span class="si">{</span><span class="n">work_pool_name</span><span class="si">!r}</span><span class="s2"> does not support custom Docker images. &quot;</span>
<span class="s2">&quot;Please use a work pool with an `image` variable in its base job template.&quot;</span>
<span class="sa">f</span><span class="s2">&quot;Work pool </span><span class="si">{</span><span class="n">work_pool_name</span><span class="si">!r}</span><span class="s2"> does not support custom Docker images.&quot;</span>
<span class="s2">&quot; Please use a work pool with an `image` variable in its base job template.&quot;</span>
<span class="s2">&quot; If you are attempting to deploy a flow to a local process work pool,&quot;</span>
<span class="s2">&quot; you should `serve` the flow instead. See the documentation for more&quot;</span>
<span class="s2">&quot; information: https://docs.prefect.io/latest/concepts/flows/&quot;</span>
<span class="p">)</span>

<span class="n">is_managed_pool</span> <span class="o">=</span> <span class="n">work_pool</span><span class="o">.</span><span class="n">is_managed_pool</span>
Expand Down
30 changes: 21 additions & 9 deletions versions/unreleased/api-ref/prefect/deployments/steps/utility/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9015,13 +9015,7 @@ <h2 id="prefect.deployments.steps.utility.pip_install_requirements" class="doc d
</details>
<details class="quote">
<summary>Source code in <code>prefect/deployments/steps/utility.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">197</span>
<span class="normal">198</span>
<span class="normal">199</span>
<span class="normal">200</span>
<span class="normal">201</span>
<span class="normal">202</span>
<span class="normal">203</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">203</span>
<span class="normal">204</span>
<span class="normal">205</span>
<span class="normal">206</span>
Expand Down Expand Up @@ -9075,7 +9069,13 @@ <h2 id="prefect.deployments.steps.utility.pip_install_requirements" class="doc d
<span class="normal">254</span>
<span class="normal">255</span>
<span class="normal">256</span>
<span class="normal">257</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">pip_install_requirements</span><span class="p">(</span>
<span class="normal">257</span>
<span class="normal">258</span>
<span class="normal">259</span>
<span class="normal">260</span>
<span class="normal">261</span>
<span class="normal">262</span>
<span class="normal">263</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">pip_install_requirements</span><span class="p">(</span>
<span class="n">directory</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">requirements_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;requirements.txt&quot;</span><span class="p">,</span>
<span class="n">stream_output</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
Expand Down Expand Up @@ -9449,7 +9449,13 @@ <h2 id="prefect.deployments.steps.utility.run_shell_script" class="doc doc-headi
<span class="normal">191</span>
<span class="normal">192</span>
<span class="normal">193</span>
<span class="normal">194</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_shell_script</span><span class="p">(</span>
<span class="normal">194</span>
<span class="normal">195</span>
<span class="normal">196</span>
<span class="normal">197</span>
<span class="normal">198</span>
<span class="normal">199</span>
<span class="normal">200</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_shell_script</span><span class="p">(</span>
<span class="n">script</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">directory</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">env</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="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -9565,6 +9571,12 @@ <h2 id="prefect.deployments.steps.utility.run_shell_script" class="doc doc-headi

<span class="k">await</span> <span class="n">process</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>

<span class="k">if</span> <span class="n">process</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;`run_shell_script` failed with error code </span><span class="si">{</span><span class="n">process</span><span class="o">.</span><span class="n">returncode</span><span class="si">}</span><span class="s2">:&quot;</span>
<span class="sa">f</span><span class="s2">&quot; </span><span class="si">{</span><span class="n">stderr_sink</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span>

<span class="k">return</span> <span class="p">{</span>
<span class="s2">&quot;stdout&quot;</span><span class="p">:</span> <span class="n">stdout_sink</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span>
<span class="s2">&quot;stderr&quot;</span><span class="p">:</span> <span class="n">stderr_sink</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span>
Expand Down
6 changes: 3 additions & 3 deletions versions/unreleased/api-ref/prefect/flows/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11074,7 +11074,7 @@ <h2 id="prefect.flows.Flow" class="doc doc-heading">
<span class="n">entrypoint</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">F</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Loads a flow from a remote s ource.</span>
<span class="sd"> Loads a flow from a remote source.</span>

<span class="sd"> Args:</span>
<span class="sd"> source: Either a URL to a git repository or a storage object.</span>
Expand Down Expand Up @@ -12253,7 +12253,7 @@ <h3 id="prefect.flows.Flow.from_source" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Loads a flow from a remote s ource.</p>
<p>Loads a flow from a remote source.</p>



Expand Down Expand Up @@ -12440,7 +12440,7 @@ <h3 id="prefect.flows.Flow.from_source" class="doc doc-heading">
<span class="n">entrypoint</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">F</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Loads a flow from a remote s ource.</span>
<span class="sd"> Loads a flow from a remote source.</span>

<span class="sd"> Args:</span>
<span class="sd"> source: Either a URL to a git repository or a storage object.</span>
Expand Down
Loading

0 comments on commit 6561ede

Please sign in to comment.