Skip to content

Commit

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

* Deployed 1f797a6 to unreleased in versions with MkDocs 1.5.3 and mike 1.1.2

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <[email protected]>
  • Loading branch information
github-actions[bot] and GitHub Actions Bot authored Sep 20, 2023
1 parent 793b88d commit 98c7679
Show file tree
Hide file tree
Showing 10 changed files with 216 additions and 219 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6979,7 +6979,7 @@ <h2 id="prefect.blocks.kubernetes.KubernetesClusterConfig" class="doc doc-headin
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Kubernetes Cluster Config&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/1zrSeY8DZ1MJZs2BAyyyGk/20445025358491b8b72600b8f996125b/Kubernetes_logo_without_workmark.svg.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/2d0b896006ad463b49c28aaac14f31e00e32cfab-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/kubernetes/#prefect.blocks.kubernetes.KubernetesClusterConfig&quot;</span>

<span class="n">config</span><span class="p">:</span> <span class="n">Dict</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7327,7 +7327,7 @@ <h2 id="prefect.blocks.notifications.CustomWebhookNotificationBlock" class="doc
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Custom Webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/6ciCsTFsvUAiiIvTllMfOU/627e9513376ca457785118fbba6a858d/webhook_icon_138018.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/c7247cb359eb6cf276734d4b1fbf00fb8930e89e-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.CustomWebhookNotificationBlock&quot;</span>

<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="s2">&quot;Name&quot;</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Name of the webhook.&quot;</span><span class="p">)</span>
Expand Down Expand Up @@ -7599,7 +7599,7 @@ <h2 id="prefect.blocks.notifications.DiscordWebhook" class="doc doc-heading">
<span class="n">_description</span> <span class="o">=</span> <span class="s2">&quot;Enables sending notifications via a provided Discord webhook.&quot;</span>
<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Discord Webhook&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;discord-webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/keir3zrx8eg0/64fsff0qm7st33BqViEpqY/e177db0d1ada88a7ee6c9433576b98d5/icons8-discord-new-480.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/9e94976c80ef925b66d24e5d14f0d47baa6b8f88-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.DiscordWebhook&quot;</span>

<span class="n">webhook_id</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -7821,7 +7821,7 @@ <h2 id="prefect.blocks.notifications.MattermostWebhook" class="doc doc-heading">
<span class="n">_description</span> <span class="o">=</span> <span class="s2">&quot;Enables sending notifications via a provided Mattermost webhook.&quot;</span>
<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Mattermost Webhook&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;mattermost-webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/zscdif0zqppk/3mlbsJDAmK402ER1sf0zUF/a48ac43fa38f395dd5f56c6ed29f22bb/mattermost-logo-png-transparent.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/1350a147130bf82cbc799a5f868d2c0116207736-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.MattermostWebhook&quot;</span>

<span class="n">hostname</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -7969,7 +7969,7 @@ <h2 id="prefect.blocks.notifications.MicrosoftTeamsWebhook" class="doc doc-headi

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Microsoft Teams Webhook&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;ms-teams-webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/6n0dSTBzwoVPhX8Vgg37i7/9040e07a62def4f48242be3eae6d3719/teams_logo.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/817efe008a57f0a24f3587414714b563e5e23658-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.MicrosoftTeamsWebhook&quot;</span>

<span class="n">url</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -8163,7 +8163,7 @@ <h2 id="prefect.blocks.notifications.OpsgenieWebhook" class="doc doc-heading">

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Opsgenie Webhook&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;opsgenie-webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/sahxz1jinscj/3habq8fTzmplh7Ctkppk4/590cecb73f766361fcea9223cd47bad8/opsgenie.png&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/d8b5bc6244ae6cd83b62ec42f10d96e14d6e9113-280x280.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.OpsgenieWebhook&quot;</span>

<span class="n">apikey</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -8433,7 +8433,7 @@ <h2 id="prefect.blocks.notifications.PagerDutyWebHook" class="doc doc-heading">

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Pager Duty Webhook&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;pager-duty-webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/6FHJ4Lcozjfl1yDPxCvQDT/c2f6bdf47327271c068284897527f3da/PagerDuty-Logo.wine.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/8dbf37d17089c1ce531708eac2e510801f7b3aee-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.PagerDutyWebHook&quot;</span>

<span class="c1"># The default cannot be prefect_default because NotifyPagerDuty&#39;s</span>
Expand Down Expand Up @@ -8643,7 +8643,7 @@ <h2 id="prefect.blocks.notifications.SendgridEmail" class="doc doc-heading">
<span class="n">_description</span> <span class="o">=</span> <span class="s2">&quot;Enables sending notifications via Sendgrid email service.&quot;</span>
<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Sendgrid Email&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;sendgrid-email&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/3PcxFuO9XUqs7wU9MiUBMg/af6affa646899cc1712d14b7fc4c0f1f/email__1_.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/82bc6ed16ca42a2252a5512c72233a253b8a58eb-250x250.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.SendgridEmail&quot;</span>

<span class="n">api_key</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -8769,7 +8769,7 @@ <h2 id="prefect.blocks.notifications.SlackWebhook" class="doc doc-heading">
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Slack Webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/7dkzINU9r6j44giEFuHuUC/85d4cd321ad60c1b1e898bc3fbd28580/5cb480cd5f1b6d3fbadece79.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/c1965ecbf8704ee1ea20d77786de9a41ce1087d1-500x500.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.SlackWebhook&quot;</span>

<span class="n">url</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -8907,7 +8907,7 @@ <h2 id="prefect.blocks.notifications.TwilioSMS" class="doc doc-heading">
<span class="n">_description</span> <span class="o">=</span> <span class="s2">&quot;Enables sending notifications via Twilio SMS.&quot;</span>
<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Twilio SMS&quot;</span>
<span class="n">_block_type_slug</span> <span class="o">=</span> <span class="s2">&quot;twilio-sms&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/zscdif0zqppk/YTCgPL6bnK3BczP2gV9md/609283105a7006c57dbfe44ee1a8f313/58482bb9cef1014c0b5e4a31.png?h=250&quot;</span> <span class="c1"># noqa</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/8bd8777999f82112c09b9c8d57083ac75a4a0d65-250x250.png&quot;</span> <span class="c1"># noqa</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.TwilioSMS&quot;</span>

<span class="n">account_sid</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down
8 changes: 4 additions & 4 deletions versions/unreleased/api-ref/prefect/blocks/system/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6886,7 +6886,7 @@ <h2 id="prefect.blocks.system.DateTime" class="doc doc-heading">
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Date Time&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/1gmljt5UBcAwEXHPnIofcE/0f3cf1da45b8b2df846e142ab52b1778/image21.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/8b3da9a6621e92108b8e6a75b82e15374e170ff7-48x48.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.DateTime&quot;</span>

<span class="n">value</span><span class="p">:</span> <span class="n">pendulum</span><span class="o">.</span><span class="n">DateTime</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -7006,7 +7006,7 @@ <h2 id="prefect.blocks.system.JSON" class="doc doc-heading">
<span class="sd"> ```</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/19W3Di10hhb4oma2Qer0x6/764d1e7b4b9974cd268c775a488b9d26/image16.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/4fcef2294b6eeb423b1332d1ece5156bf296ff96-48x48.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.JSON&quot;</span>

<span class="n">value</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=...</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s2">&quot;A JSON-compatible value.&quot;</span><span class="p">)</span>
Expand Down Expand Up @@ -7137,7 +7137,7 @@ <h2 id="prefect.blocks.system.Secret" class="doc doc-heading">
<span class="sd"> ```</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/5uUmyGBjRejYuGTWbTxz6E/3003e1829293718b3a5d2e909643a331/image8.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/c6f20e556dd16effda9df16551feecfb5822092b-48x48.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.Secret&quot;</span>

<span class="n">value</span><span class="p">:</span> <span class="n">SecretStr</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down Expand Up @@ -7259,7 +7259,7 @@ <h2 id="prefect.blocks.system.String" class="doc doc-heading">
<span class="sd"> ```</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/4zjrZmh9tBrFiikeB44G4O/2ce1dbbac1c8e356f7c429e0f8bbb58d/image10.png?h=250&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/c262ea2c80a2c043564e8763f3370c3db5a6b3e6-48x48.png&quot;</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.String&quot;</span>

<span class="n">value</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=...</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s2">&quot;A string value.&quot;</span><span class="p">)</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6828,7 +6828,7 @@ <h2 id="prefect.blocks.webhook.Webhook" class="doc doc-heading">
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">_block_type_name</span> <span class="o">=</span> <span class="s2">&quot;Webhook&quot;</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://images.ctfassets.net/gm98wzqotmnx/6ciCsTFsvUAiiIvTllMfOU/627e9513376ca457785118fbba6a858d/webhook_icon_138018.png?h=250&quot;</span> <span class="c1"># type: ignore</span>
<span class="n">_logo_url</span> <span class="o">=</span> <span class="s2">&quot;https://cdn.sanity.io/images/3ugk85nk/production/c7247cb359eb6cf276734d4b1fbf00fb8930e89e-250x250.png&quot;</span> <span class="c1"># type: ignore</span>
<span class="n">_documentation_url</span> <span class="o">=</span> <span class="s2">&quot;https://docs.prefect.io/api-ref/prefect/blocks/webhook/#prefect.blocks.webhook.Webhook&quot;</span>

<span class="n">method</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="s2">&quot;POST&quot;</span><span class="p">,</span> <span class="s2">&quot;PUT&quot;</span><span class="p">,</span> <span class="s2">&quot;PATCH&quot;</span><span class="p">,</span> <span class="s2">&quot;DELETE&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
Expand Down
Loading

0 comments on commit 98c7679

Please sign in to comment.