Update unreleased documentation (#776)

* Update versions.json * Deployed aef4234 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]>
PrefectHQ · May 16, 2024 · b9b8a84 · b9b8a84
1 parent c07a914
commit b9b8a84
Show file tree

Hide file tree

Showing 233 changed files with 104,201 additions and 109,529 deletions.
diff --git a/versions/unreleased/api-ref/prefect/agent/index.html b/versions/unreleased/api-ref/prefect/agent/index.html
@@ -13269,19 +13269,19 @@
 
 
 <h1 id="prefect.agent" class="doc doc-heading">
-          <code>prefect.agent</code>
+            <code>prefect.agent</code>
 
 
 <a href="#prefect.agent" class="headerlink" title="Permanent link">&para;</a></h1>
 
-  <div class="doc doc-contents first">
-  
+    <div class="doc doc-contents first">
+
       <p>DEPRECATION WARNING:</p>
 <p>This module is deprecated as of March 2024 and will not be available after September 2024.
 Agents have been replaced by workers, which offer enhanced functionality and better performance.</p>
 <p>For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.</p>
 
-  
+
 
   <div class="doc doc-children">
 
@@ -13297,18 +13297,18 @@ <h1 id="prefect.agent" class="doc doc-heading">
 
 
 <h2 id="prefect.agent.PrefectAgent" class="doc doc-heading">
-          <code>PrefectAgent</code>
+            <code>PrefectAgent</code>
 
 
 <a href="#prefect.agent.PrefectAgent" class="headerlink" title="Permanent link">&para;</a></h2>
 
 
-  <div class="doc doc-contents ">
+    <div class="doc doc-contents ">
 
 
-            <details class="quote">
-              <summary>Source code in <code>prefect/agent.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 54</span>
+              <details class="quote">
+                <summary>Source code in <code>prefect/agent.py</code></summary>
+                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 54</span>
 <span class="normal"> 55</span>
 <span class="normal"> 56</span>
 <span class="normal"> 57</span>
@@ -14598,12 +14598,11 @@ <h2 id="prefect.agent.PrefectAgent" class="doc doc-heading">
     <span class="k">async</span> <span class="k">def</span> <span class="fm">__aexit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">exc_info</span><span class="p">):</span>
         <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">shutdown</span><span class="p">(</span><span class="o">*</span><span class="n">exc_info</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
-            </details>
+              </details>
 
-
 
-  <div class="doc doc-children">
 
+  <div class="doc doc-children">
 
 
 
@@ -14616,24 +14615,23 @@ <h2 id="prefect.agent.PrefectAgent" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-
 <h3 id="prefect.agent.PrefectAgent.cancel_run" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">cancel_run</span></code>
-  
+            <code class="highlight language-python"><span class="n">cancel_run</span></code>
+
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
 <a href="#prefect.agent.PrefectAgent.cancel_run" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
-  <div class="doc doc-contents ">
-  
+    <div class="doc doc-contents ">
+
       <p>Cancel a flow run by killing its infrastructure</p>
 
-          <details class="quote">
-            <summary>Source code in <code>prefect/agent.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">331</span>
+            <details class="quote">
+              <summary>Source code in <code>prefect/agent.py</code></summary>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">331</span>
 <span class="normal">332</span>
 <span class="normal">333</span>
 <span class="normal">334</span>
@@ -14769,34 +14767,32 @@ <h3 id="prefect.agent.PrefectAgent.cancel_run" class="doc doc-heading">
         <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mark_flow_run_as_cancelled</span><span class="p">(</span><span class="n">flow_run</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Cancelled flow run &#39;</span><span class="si">{</span><span class="n">flow_run</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&#39;!&quot;</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
-          </details>
-  </div>
+            </details>
+    </div>
 
 </div>
 
-
 <div class="doc doc-object doc-function">
 
 
-
 <h3 id="prefect.agent.PrefectAgent.get_and_submit_flow_runs" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">get_and_submit_flow_runs</span></code>
-  
+            <code class="highlight language-python"><span class="n">get_and_submit_flow_runs</span></code>
+
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
 <a href="#prefect.agent.PrefectAgent.get_and_submit_flow_runs" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
-  <div class="doc doc-contents ">
-  
+    <div class="doc doc-contents ">
+
       <p>The principle method on agents. Queries for scheduled flow runs and submits
 them for execution in parallel.</p>
 
-          <details class="quote">
-            <summary>Source code in <code>prefect/agent.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">197</span>
+            <details class="quote">
+              <summary>Source code in <code>prefect/agent.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>
@@ -14948,34 +14944,32 @@ <h3 id="prefect.agent.PrefectAgent.get_and_submit_flow_runs" class="doc doc-head
         <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">run</span><span class="p">:</span> <span class="n">run</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">submitting_flow_run_ids</span><span class="p">,</span> <span class="n">submittable_runs</span><span class="p">)</span>
     <span class="p">)</span>
 </code></pre></div></td></tr></table></div>
-          </details>
-  </div>
+            </details>
+    </div>
 
 </div>
 
-
 <div class="doc doc-object doc-function">
 
 
-
 <h3 id="prefect.agent.PrefectAgent.get_work_queues" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">get_work_queues</span></code>
-  
+            <code class="highlight language-python"><span class="n">get_work_queues</span></code>
+
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
 <a href="#prefect.agent.PrefectAgent.get_work_queues" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
-  <div class="doc doc-contents ">
-  
+    <div class="doc doc-contents ">
+
       <p>Loads the work queue objects corresponding to the agent's target work
 queues. If any of them don't exist, they are created.</p>
 
-          <details class="quote">
-            <summary>Source code in <code>prefect/agent.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">135</span>
+            <details class="quote">
+              <summary>Source code in <code>prefect/agent.py</code></summary>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">135</span>
 <span class="normal">136</span>
 <span class="normal">137</span>
 <span class="normal">138</span>
@@ -15097,33 +15091,31 @@ <h3 id="prefect.agent.PrefectAgent.get_work_queues" class="doc doc-heading">
             <span class="bp">self</span><span class="o">.</span><span class="n">_work_queue_cache</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">work_queue</span><span class="p">)</span>
             <span class="k">yield</span> <span class="n">work_queue</span>
 </code></pre></div></td></tr></table></div>
-          </details>
-  </div>
+            </details>
+    </div>
 
 </div>
 
-
 <div class="doc doc-object doc-function">
 
 
-
 <h3 id="prefect.agent.PrefectAgent.submit_run" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">submit_run</span></code>
-  
+            <code class="highlight language-python"><span class="n">submit_run</span></code>
+
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
 <a href="#prefect.agent.PrefectAgent.submit_run" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
-  <div class="doc doc-contents ">
-  
+    <div class="doc doc-contents ">
+
       <p>Submit a flow run to the infrastructure</p>
 
-          <details class="quote">
-            <summary>Source code in <code>prefect/agent.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">471</span>
+            <details class="quote">
+              <summary>Source code in <code>prefect/agent.py</code></summary>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">471</span>
 <span class="normal">472</span>
 <span class="normal">473</span>
 <span class="normal">474</span>
@@ -15211,17 +15203,16 @@ <h3 id="prefect.agent.PrefectAgent.submit_run" class="doc doc-heading">
 
     <span class="bp">self</span><span class="o">.</span><span class="n">submitting_flow_run_ids</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">flow_run</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
-          </details>
-  </div>
+            </details>
+    </div>
 
 </div>
 
 
 
   </div>
 
-  </div>
-
+    </div>
 
 </div>
 
@@ -15230,7 +15221,7 @@ <h3 id="prefect.agent.PrefectAgent.submit_run" class="doc doc-heading">
 
   </div>
 
-  </div>
+    </div>
 
 </div>