Update unreleased documentation (#561)

* Update versions.json * Deployed f3126fd 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 · Jan 11, 2024 · d59b357 · d59b357
1 parent ac54e02
commit d59b357
Show file tree

Hide file tree

Showing 14 changed files with 681 additions and 574 deletions.
diff --git a/versions/unreleased/api-ref/prefect/cli/deployment/index.html b/versions/unreleased/api-ref/prefect/cli/deployment/index.html
@@ -10842,7 +10842,7 @@ <h2 id="prefect.cli.deployment.run" class="doc doc-heading">
                         <span class="s2">&quot;RETURN_AS_TIMEZONE_AWARE&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
                         <span class="s2">&quot;PREFER_DATES_FROM&quot;</span><span class="p">:</span> <span class="s2">&quot;future&quot;</span><span class="p">,</span>
                         <span class="s2">&quot;RELATIVE_BASE&quot;</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span>
-                            <span class="n">now</span><span class="o">.</span><span class="n">timestamp</span><span class="p">(),</span> <span class="n">tz</span><span class="o">=</span><span class="n">pendulum</span><span class="o">.</span><span class="n">tz</span><span class="o">.</span><span class="n">UTC</span>
+                            <span class="n">now</span><span class="o">.</span><span class="n">timestamp</span><span class="p">(),</span> <span class="n">tz</span><span class="o">=</span><span class="n">timezone</span><span class="o">.</span><span class="n">utc</span>
                         <span class="p">),</span>
                     <span class="p">},</span>
                 <span class="p">)</span>

diff --git a/versions/unreleased/api-ref/prefect/cli/dev/index.html b/versions/unreleased/api-ref/prefect/cli/dev/index.html
@@ -8908,11 +8908,7 @@ <h2 id="prefect.cli.dev.agent" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">260</span>
-<span class="normal">261</span>
-<span class="normal">262</span>
-<span class="normal">263</span>
-<span class="normal">264</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">264</span>
 <span class="normal">265</span>
 <span class="normal">266</span>
 <span class="normal">267</span>
@@ -8936,7 +8932,11 @@ <h2 id="prefect.cli.dev.agent" class="doc doc-heading">
 <span class="normal">285</span>
 <span class="normal">286</span>
 <span class="normal">287</span>
-<span class="normal">288</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">288</span>
+<span class="normal">289</span>
+<span class="normal">290</span>
+<span class="normal">291</span>
+<span class="normal">292</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_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">agent</span><span class="p">(</span>
     <span class="n">api_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">SettingsOption</span><span class="p">(</span><span class="n">PREFECT_API_URL</span><span class="p">),</span>
     <span class="n">work_queues</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>
@@ -9120,11 +9120,7 @@ <h2 id="prefect.cli.dev.api" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">193</span>
-<span class="normal">194</span>
-<span class="normal">195</span>
-<span class="normal">196</span>
-<span class="normal">197</span>
+            <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>
@@ -9184,7 +9180,11 @@ <h2 id="prefect.cli.dev.api" class="doc doc-heading">
 <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="nd">@dev_app</span><span class="o">.</span><span class="n">command</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></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_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">api</span><span class="p">(</span>
     <span class="n">host</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">SettingsOption</span><span class="p">(</span><span class="n">PREFECT_SERVER_API_HOST</span><span class="p">),</span>
     <span class="n">port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">SettingsOption</span><span class="p">(</span><span class="n">PREFECT_SERVER_API_PORT</span><span class="p">),</span>
@@ -9338,11 +9338,7 @@ <h2 id="prefect.cli.dev.build_image" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">329</span>
-<span class="normal">330</span>
-<span class="normal">331</span>
-<span class="normal">332</span>
-<span class="normal">333</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">333</span>
 <span class="normal">334</span>
 <span class="normal">335</span>
 <span class="normal">336</span>
@@ -9404,7 +9400,11 @@ <h2 id="prefect.cli.dev.build_image" class="doc doc-heading">
 <span class="normal">392</span>
 <span class="normal">393</span>
 <span class="normal">394</span>
-<span class="normal">395</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">395</span>
+<span class="normal">396</span>
+<span class="normal">397</span>
+<span class="normal">398</span>
+<span class="normal">399</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
 <span class="k">def</span> <span class="nf">build_image</span><span class="p">(</span>
     <span class="n">arch</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>
@@ -9494,11 +9494,7 @@ <h2 id="prefect.cli.dev.container" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">398</span>
-<span class="normal">399</span>
-<span class="normal">400</span>
-<span class="normal">401</span>
-<span class="normal">402</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">402</span>
 <span class="normal">403</span>
 <span class="normal">404</span>
 <span class="normal">405</span>
@@ -9580,7 +9576,11 @@ <h2 id="prefect.cli.dev.container" class="doc doc-heading">
 <span class="normal">481</span>
 <span class="normal">482</span>
 <span class="normal">483</span>
-<span class="normal">484</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">484</span>
+<span class="normal">485</span>
+<span class="normal">486</span>
+<span class="normal">487</span>
+<span class="normal">488</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
 <span class="k">def</span> <span class="nf">container</span><span class="p">(</span><span class="n">bg</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;prefect-dev&quot;</span><span class="p">,</span> <span class="n">api</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">tag</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Run a docker container with local code mounted and installed.</span>
@@ -9694,11 +9694,7 @@ <h2 id="prefect.cli.dev.kubernetes_manifest" class="doc doc-heading">
 </details>
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">487</span>
-<span class="normal">488</span>
-<span class="normal">489</span>
-<span class="normal">490</span>
-<span class="normal">491</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">491</span>
 <span class="normal">492</span>
 <span class="normal">493</span>
 <span class="normal">494</span>
@@ -9715,7 +9711,11 @@ <h2 id="prefect.cli.dev.kubernetes_manifest" class="doc doc-heading">
 <span class="normal">505</span>
 <span class="normal">506</span>
 <span class="normal">507</span>
-<span class="normal">508</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">508</span>
+<span class="normal">509</span>
+<span class="normal">510</span>
+<span class="normal">511</span>
+<span class="normal">512</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
 <span class="k">def</span> <span class="nf">kubernetes_manifest</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Generates a Kubernetes manifest for development.</span>
@@ -9766,11 +9766,7 @@ <h2 id="prefect.cli.dev.start" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">291</span>
-<span class="normal">292</span>
-<span class="normal">293</span>
-<span class="normal">294</span>
-<span class="normal">295</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">295</span>
 <span class="normal">296</span>
 <span class="normal">297</span>
 <span class="normal">298</span>
@@ -9801,7 +9797,11 @@ <h2 id="prefect.cli.dev.start" class="doc doc-heading">
 <span class="normal">323</span>
 <span class="normal">324</span>
 <span class="normal">325</span>
-<span class="normal">326</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">326</span>
+<span class="normal">327</span>
+<span class="normal">328</span>
+<span class="normal">329</span>
+<span class="normal">330</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_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">exclude_api</span><span class="p">:</span> <span class="nb">bool</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">False</span><span class="p">,</span> <span class="s2">&quot;--no-api&quot;</span><span class="p">),</span>
     <span class="n">exclude_ui</span><span class="p">:</span> <span class="nb">bool</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">False</span><span class="p">,</span> <span class="s2">&quot;--no-ui&quot;</span><span class="p">),</span>
@@ -9864,19 +9864,19 @@ <h2 id="prefect.cli.dev.ui" class="doc doc-heading">
 
           <details class="quote">
             <summary>Source code in <code>prefect/cli/dev.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">178</span>
-<span class="normal">179</span>
-<span class="normal">180</span>
-<span class="normal">181</span>
-<span class="normal">182</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">182</span>
 <span class="normal">183</span>
 <span class="normal">184</span>
 <span class="normal">185</span>
 <span class="normal">186</span>
 <span class="normal">187</span>
 <span class="normal">188</span>
 <span class="normal">189</span>
-<span class="normal">190</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@dev_app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
+<span class="normal">190</span>
+<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="nd">@dev_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">ui</span><span class="p">():</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Starts a hot-reloading development UI.</span>