Skip to content

Commit

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

* Deployed da76961 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 Dec 12, 2023
1 parent a0971da commit 3461b9c
Show file tree
Hide file tree
Showing 11 changed files with 1,139 additions and 643 deletions.
150 changes: 82 additions & 68 deletions versions/unreleased/api-ref/prefect/deployments/runner/index.html
View file

Large diffs are not rendered by default.

166 changes: 146 additions & 20 deletions versions/unreleased/api-ref/prefect/infrastructure/index.html
View file

Large diffs are not rendered by default.

643 changes: 344 additions & 299 deletions versions/unreleased/api-ref/prefect/settings/index.html
View file

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions versions/unreleased/api-ref/prefect/utilities/processutils/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7120,10 +7120,7 @@ <h2 id="prefect.utilities.processutils.forward_signal_handler" class="doc doc-he

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">318</span>
<span class="normal">319</span>
<span class="normal">320</span>
<span class="normal">321</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">321</span>
<span class="normal">322</span>
<span class="normal">323</span>
<span class="normal">324</span>
Expand Down Expand Up @@ -7151,7 +7148,10 @@ <h2 id="prefect.utilities.processutils.forward_signal_handler" class="doc doc-he
<span class="normal">346</span>
<span class="normal">347</span>
<span class="normal">348</span>
<span class="normal">349</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">forward_signal_handler</span><span class="p">(</span>
<span class="normal">349</span>
<span class="normal">350</span>
<span class="normal">351</span>
<span class="normal">352</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">forward_signal_handler</span><span class="p">(</span>
<span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">signum</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="o">*</span><span class="n">signums</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Forward subsequent signum events (e.g. interrupts) to respective signums.&quot;&quot;&quot;</span>
Expand Down Expand Up @@ -7214,7 +7214,8 @@ <h2 id="prefect.utilities.processutils.open_process" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">181</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">180</span>
<span class="normal">181</span>
<span class="normal">182</span>
<span class="normal">183</span>
<span class="normal">184</span>
Expand Down Expand Up @@ -7268,8 +7269,7 @@ <h2 id="prefect.utilities.processutils.open_process" class="doc doc-heading">
<span class="normal">232</span>
<span class="normal">233</span>
<span class="normal">234</span>
<span class="normal">235</span>
<span class="normal">236</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@asynccontextmanager</span>
<span class="normal">235</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@asynccontextmanager</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">open_process</span><span class="p">(</span><span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Like `anyio.open_process` but with:</span>
Expand Down Expand Up @@ -7359,7 +7359,8 @@ <h2 id="prefect.utilities.processutils.run_process" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">239</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">238</span>
<span class="normal">239</span>
<span class="normal">240</span>
<span class="normal">241</span>
<span class="normal">242</span>
Expand Down Expand Up @@ -7398,8 +7399,7 @@ <h2 id="prefect.utilities.processutils.run_process" class="doc doc-heading">
<span class="normal">275</span>
<span class="normal">276</span>
<span class="normal">277</span>
<span class="normal">278</span>
<span class="normal">279</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_process</span><span class="p">(</span>
<span class="normal">278</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_process</span><span class="p">(</span>
<span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
<span class="n">stream_output</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">TextSink</span><span class="p">],</span> <span class="n">Optional</span><span class="p">[</span><span class="n">TextSink</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">task_status</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">anyio</span><span class="o">.</span><span class="n">abc</span><span class="o">.</span><span class="n">TaskStatus</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -7464,10 +7464,7 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_agent" class="doc d

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">369</span>
<span class="normal">370</span>
<span class="normal">371</span>
<span class="normal">372</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">372</span>
<span class="normal">373</span>
<span class="normal">374</span>
<span class="normal">375</span>
Expand All @@ -7479,7 +7476,10 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_agent" class="doc d
<span class="normal">381</span>
<span class="normal">382</span>
<span class="normal">383</span>
<span class="normal">384</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_agent</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="normal">384</span>
<span class="normal">385</span>
<span class="normal">386</span>
<span class="normal">387</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_agent</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Handle interrupts of the agent gracefully.&quot;&quot;&quot;</span>
<span class="n">setup_handler</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span>
<span class="n">forward_signal_handler</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">process_name</span><span class="o">=</span><span class="n">process_name</span><span class="p">,</span> <span class="n">print_fn</span><span class="o">=</span><span class="n">print_fn</span>
Expand Down Expand Up @@ -7519,10 +7519,7 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_server" class="doc

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">352</span>
<span class="normal">353</span>
<span class="normal">354</span>
<span class="normal">355</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">355</span>
<span class="normal">356</span>
<span class="normal">357</span>
<span class="normal">358</span>
Expand All @@ -7533,7 +7530,10 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_server" class="doc
<span class="normal">363</span>
<span class="normal">364</span>
<span class="normal">365</span>
<span class="normal">366</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_server</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="normal">366</span>
<span class="normal">367</span>
<span class="normal">368</span>
<span class="normal">369</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_server</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Handle interrupts of the server gracefully.&quot;&quot;&quot;</span>
<span class="n">setup_handler</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span>
<span class="n">forward_signal_handler</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">process_name</span><span class="o">=</span><span class="n">process_name</span><span class="p">,</span> <span class="n">print_fn</span><span class="o">=</span><span class="n">print_fn</span>
Expand Down Expand Up @@ -7572,10 +7572,7 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_worker" class="doc

<details class="quote">
<summary>Source code in <code>prefect/utilities/processutils.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">387</span>
<span class="normal">388</span>
<span class="normal">389</span>
<span class="normal">390</span>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">390</span>
<span class="normal">391</span>
<span class="normal">392</span>
<span class="normal">393</span>
Expand All @@ -7587,7 +7584,10 @@ <h2 id="prefect.utilities.processutils.setup_signal_handlers_worker" class="doc
<span class="normal">399</span>
<span class="normal">400</span>
<span class="normal">401</span>
<span class="normal">402</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_worker</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="normal">402</span>
<span class="normal">403</span>
<span class="normal">404</span>
<span class="normal">405</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">setup_signal_handlers_worker</span><span class="p">(</span><span class="n">pid</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">process_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">print_fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Handle interrupts of workers gracefully.&quot;&quot;&quot;</span>
<span class="n">setup_handler</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span>
<span class="n">forward_signal_handler</span><span class="p">,</span> <span class="n">pid</span><span class="p">,</span> <span class="n">process_name</span><span class="o">=</span><span class="n">process_name</span><span class="p">,</span> <span class="n">print_fn</span><span class="o">=</span><span class="n">print_fn</span>
Expand Down
2 changes: 1 addition & 1 deletion versions/unreleased/api-ref/schema.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 3461b9c

Please sign in to comment.