Update unreleased documentation (#641)

* Update versions.json * Deployed 151b271 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 · Feb 29, 2024 · 859b836 · 859b836
1 parent 9399f2b
commit 859b836
Show file tree

Hide file tree

Showing 13 changed files with 2,664 additions and 1,960 deletions.
diff --git a/versions/unreleased/api-ref/prefect/cli/deploy/index.html b/versions/unreleased/api-ref/prefect/cli/deploy/index.html
@@ -9279,12 +9279,12 @@ <h2 id="prefect.cli.deploy.deploy" class="doc doc-heading">
             <span class="s2">&quot; format of key=value string or a JSON object&quot;</span>
         <span class="p">),</span>
     <span class="p">),</span>
-    <span class="n">cron</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="n">cron</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">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
         <span class="kc">None</span><span class="p">,</span>
         <span class="s2">&quot;--cron&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;A cron string that will be used to set a CronSchedule on the deployment.&quot;</span><span class="p">,</span>
     <span class="p">),</span>
-    <span class="n">interval</span><span class="p">:</span> <span class="nb">int</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="n">interval</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]</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>
         <span class="s2">&quot;--interval&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="p">(</span>
@@ -9293,9 +9293,9 @@ <h2 id="prefect.cli.deploy.deploy" class="doc doc-heading">
         <span class="p">),</span>
     <span class="p">),</span>
     <span class="n">interval_anchor</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="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> <span class="s2">&quot;--anchor-date&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The anchor date for an interval schedule&quot;</span>
+        <span class="kc">None</span><span class="p">,</span> <span class="s2">&quot;--anchor-date&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The anchor date for all interval schedules&quot;</span>
     <span class="p">),</span>
-    <span class="n">rrule</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="n">rrule</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">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
         <span class="kc">None</span><span class="p">,</span>
         <span class="s2">&quot;--rrule&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;An RRule that will be used to set an RRuleSchedule on the deployment.&quot;</span><span class="p">,</span>

diff --git a/versions/unreleased/api-ref/prefect/cli/flow/index.html b/versions/unreleased/api-ref/prefect/cli/flow/index.html
@@ -8992,8 +8992,7 @@ <h2 id="prefect.cli.flow.ls" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/flow.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">25</span>
-<span class="normal">26</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">26</span>
 <span class="normal">27</span>
 <span class="normal">28</span>
 <span class="normal">29</span>
@@ -9017,7 +9016,8 @@ <h2 id="prefect.cli.flow.ls" class="doc doc-heading">
 <span class="normal">47</span>
 <span class="normal">48</span>
 <span class="normal">49</span>
-<span class="normal">50</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@flow_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">50</span>
+<span class="normal">51</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@flow_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">ls</span><span class="p">(</span>
     <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">15</span><span class="p">,</span>
 <span class="p">):</span>
@@ -9070,8 +9070,7 @@ <h2 id="prefect.cli.flow.serve" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/flow.py</code></summary>
-            <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>
+            <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>
@@ -9179,7 +9178,10 @@ <h2 id="prefect.cli.flow.serve" class="doc doc-heading">
 <span class="normal">159</span>
 <span class="normal">160</span>
 <span class="normal">161</span>
-<span class="normal">162</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@flow_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">162</span>
+<span class="normal">163</span>
+<span class="normal">164</span>
+<span class="normal">165</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@flow_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">serve</span><span class="p">(</span>
     <span class="n">entrypoint</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">Argument</span><span class="p">(</span>
         <span class="o">...</span><span class="p">,</span>
@@ -9254,7 +9256,7 @@ <h2 id="prefect.cli.flow.serve" class="doc doc-heading">
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">runner</span> <span class="o">=</span> <span class="n">Runner</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">pause_on_shutdown</span><span class="o">=</span><span class="n">pause_on_shutdown</span><span class="p">)</span>
     <span class="k">try</span><span class="p">:</span>
-        <span class="n">schedule</span> <span class="o">=</span> <span class="kc">None</span>
+        <span class="n">schedules</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="k">if</span> <span class="n">interval</span> <span class="ow">or</span> <span class="n">cron</span> <span class="ow">or</span> <span class="n">rrule</span><span class="p">:</span>
             <span class="n">schedule</span> <span class="o">=</span> <span class="n">construct_schedule</span><span class="p">(</span>
                 <span class="n">interval</span><span class="o">=</span><span class="n">interval</span><span class="p">,</span>
@@ -9263,10 +9265,12 @@ <h2 id="prefect.cli.flow.serve" class="doc doc-heading">
                 <span class="n">timezone</span><span class="o">=</span><span class="n">timezone</span><span class="p">,</span>
                 <span class="n">anchor_date</span><span class="o">=</span><span class="n">interval_anchor</span><span class="p">,</span>
             <span class="p">)</span>
+            <span class="n">schedules</span> <span class="o">=</span> <span class="p">[</span><span class="n">MinimalDeploymentSchedule</span><span class="p">(</span><span class="n">schedule</span><span class="o">=</span><span class="n">schedule</span><span class="p">,</span> <span class="n">active</span><span class="o">=</span><span class="kc">True</span><span class="p">)]</span>
+
         <span class="n">runner_deployment</span> <span class="o">=</span> <span class="n">RunnerDeployment</span><span class="o">.</span><span class="n">from_entrypoint</span><span class="p">(</span>
             <span class="n">entrypoint</span><span class="o">=</span><span class="n">entrypoint</span><span class="p">,</span>
             <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
-            <span class="n">schedule</span><span class="o">=</span><span class="n">schedule</span><span class="p">,</span>
+            <span class="n">schedules</span><span class="o">=</span><span class="n">schedules</span><span class="p">,</span>
             <span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
             <span class="n">tags</span><span class="o">=</span><span class="n">tags</span> <span class="ow">or</span> <span class="p">[],</span>
             <span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span>