Skip to content

Commit

Permalink
Deployed 234b2b4 to 1.0.9 with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nicklambourne committed May 31, 2024
1 parent bfbcbf4 commit 2a0f86c
Show file tree
Hide file tree
Showing 11 changed files with 96 additions and 96 deletions.
22 changes: 11 additions & 11 deletions 1.0.9/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -860,29 +860,29 @@ <h2 id="components">Components</h2>
<p><code>slackblocks</code> makes using this API easier by providing a hierarchy of Python
classes that represent these resources.</p>
<h3 id="objects">Objects</h3>
<p><a href="/slackblocks/latest/reference/messages/objects"><code>Objects</code></a> (e.g. <a href="/slackblocks/latest/reference/messages/objects/#objects.Text"><code>Text</code></a>)
<p><a href="/slackblocks/latest/reference/objects"><code>Objects</code></a> (e.g. <a href="/slackblocks/latest/reference/objects/#objects.Text"><code>Text</code></a>)
are the lowest level pimitives that are used to populate
<a href="/slackblocks/latest/reference/messages/elements"><code>Elements</code></a> and <a href="/slackblocks/latest/reference/messages/blocks"><code>Blocks</code></a>.</p>
<a href="/slackblocks/latest/reference/elements"><code>Elements</code></a> and <a href="/slackblocks/latest/reference/blocks"><code>Blocks</code></a>.</p>
<h3 id="elements">Elements</h3>
<p><a href="/slackblocks/latest/reference/messages/elements"><code>Elements</code></a> are typically interactive UI elements that take
in <a href="/slackblocks/latest/reference/messages/objects"><code>Object</code></a> to define their content. For example, the
<p><a href="/slackblocks/latest/reference/elements"><code>Elements</code></a> are typically interactive UI elements that take
in <a href="/slackblocks/latest/reference/objects"><code>Object</code></a> to define their content. For example, the
<a href="/elements/#elements.CheckboxGroup"><code>CheckboxGroup</code></a> element takes in one or
more <a href="/slackblocks/latest/reference/messages/objects/#objects.Option"><code>Option</code></a> items and presents a
more <a href="/slackblocks/latest/reference/objects/#objects.Option"><code>Option</code></a> items and presents a
checkbox menu to the user with those options.</p>
<h3 id="blocks">Blocks</h3>
<p><a href="/slackblocks/latest/reference/messages/blocks"><code>Blocks</code></a> are the core element of the API, with different
<a href="/slackblocks/latest/reference/messages/blocks"><code>Blocks</code></a> used to create different types of visual
elements. For example, the <a href="/slackblocks/latest/reference/messages/blocks/#blocks.DividerBlock"><code>DividerBlock</code></a>,
<p><a href="/slackblocks/latest/reference/blocks"><code>Blocks</code></a> are the core element of the API, with different
<a href="/slackblocks/latest/reference/blocks"><code>Blocks</code></a> used to create different types of visual
elements. For example, the <a href="/slackblocks/latest/reference/blocks/#blocks.DividerBlock"><code>DividerBlock</code></a>,
when rendered, will show a visual element similar to a <code>&lt;hr&gt;</code> HTML element. The
<a href="/slackblocks/latest/reference/messages/blocks/#blocks.RichTextBlock"><code>RichTextBlock</code></a> on the other hand
<a href="/slackblocks/latest/reference/blocks/#blocks.RichTextBlock"><code>RichTextBlock</code></a> on the other hand
allows for the display of text elements with visual styling like italics,
block quotes, lists and code blocks. </p>
<h3 id="messages">Messages</h3>
<p><a href="/slackblocks/latest/reference/messages/messages/"><code>Messages</code></a> are a convenience wrapper around <code>Blocks</code> that
<p><a href="/slackblocks/latest/reference/messages/"><code>Messages</code></a> are a convenience wrapper around <code>Blocks</code> that
can be unpacked as arguments straight into the official Slack Python SDK (or
its legacy <code>slackclient</code> counterpart).</p>
<h3 id="views">Views</h3>
<p><a href="reference/views/"><code>Views</code></a> are an alternative usage for <a href="/slackblocks/latest/reference/messages/blocks"><code>Blocks</code></a>
<p><a href="reference/views/"><code>Views</code></a> are an alternative usage for <a href="/slackblocks/latest/reference/blocks"><code>Blocks</code></a>
that allow for the creation of custom UI "surfaces" within Slack, e.g. for
third-party apps.</p>
<h2 id="guides">Guides</h2>
Expand Down
6 changes: 3 additions & 3 deletions 1.0.9/reference/attachments/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ <h1 id="attachments">Attachments</h1>

<p>Secondary (less important) content can be attached using the deprecated
attachments API.</p>
<p>See: <a href="https://api.slack.com/slackblocks/latest/reference/messages/messaging/attachments">https://api.slack.com/slackblocks/latest/reference/messages/messaging/attachments</a>.</p>
<p>See: <a href="https://api.slack.com/slackblocks/latest/reference/messaging/attachments">https://api.slack.com/slackblocks/latest/reference/messaging/attachments</a>.</p>



Expand Down Expand Up @@ -1026,7 +1026,7 @@ <h3 id="attachments.Color" class="doc doc-heading">

<p>Color is a utility class for use with the Slack secondary attachments API.</p>
<p>Pass these to the <code>color</code> argument of
<a href="/slackblocks/latest/reference/messages/attachments/#attachments.Attachment"><code>Attachment</code></a>.</p>
<a href="/slackblocks/latest/reference/attachments/#attachments.Attachment"><code>Attachment</code></a>.</p>
<table style="width:50%">
<tr>
<td><code>Color.GOOD</code></td>
Expand Down Expand Up @@ -1180,7 +1180,7 @@ <h3 id="attachments.Color" class="doc doc-heading">
<span class="sd"> Color is a utility class for use with the Slack secondary attachments API.</span>

<span class="sd"> Pass these to the `color` argument of</span>
<span class="sd"> [`Attachment`](/slackblocks/latest/reference/messages/attachments/#attachments.Attachment).</span>
<span class="sd"> [`Attachment`](/slackblocks/latest/reference/attachments/#attachments.Attachment).</span>

<span class="sd"> &lt;table style=&quot;width:50%&quot;&gt;</span>
<span class="sd"> &lt;tr&gt;</span>
Expand Down
28 changes: 14 additions & 14 deletions 1.0.9/reference/blocks/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ <h3 id="blocks.ActionsBlock" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>a list of <a href="/slackblocks/latest/reference/messages/elements">Elements</a> (up to a maximum of 25).</p>
<p>a list of <a href="/slackblocks/latest/reference/elements">Elements</a> (up to a maximum of 25).</p>
</div>
</td>
<td>
Expand Down Expand Up @@ -991,7 +991,7 @@ <h3 id="blocks.ActionsBlock" class="doc doc-heading">
<span class="sd"> A `Block` that is used to hold interactive elements (normally for users to interface with).</span>

<span class="sd"> Args:</span>
<span class="sd"> elements: a list of [Elements](/slackblocks/latest/reference/messages/elements) (up to a maximum of 25).</span>
<span class="sd"> elements: a list of [Elements](/slackblocks/latest/reference/elements) (up to a maximum of 25).</span>
<span class="sd"> block_id: you can use this field to provide a deterministic identifier for the block.</span>

<span class="sd"> Throws:</span>
Expand Down Expand Up @@ -1850,7 +1850,7 @@ <h3 id="blocks.InputBlock" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>an interactive <a href="/slackblocks/latest/reference/messages/elements">Element</a> (e.g. a text field).</p>
<p>an interactive <a href="/slackblocks/latest/reference/elements">Element</a> (e.g. a text field).</p>
</div>
</td>
<td>
Expand All @@ -1864,7 +1864,7 @@ <h3 id="blocks.InputBlock" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>whether the <a href="/slackblocks/latest/reference/messages/elements">Element</a> should trigger the
<p>whether the <a href="/slackblocks/latest/reference/elements">Element</a> should trigger the
sending of a <code>block_actions</code> payload.</p>
</div>
</td>
Expand Down Expand Up @@ -1982,8 +1982,8 @@ <h3 id="blocks.InputBlock" class="doc doc-heading">

<span class="sd"> Args:</span>
<span class="sd"> label: the name which identifies the input field.</span>
<span class="sd"> element: an interactive [Element](/slackblocks/latest/reference/messages/elements) (e.g. a text field).</span>
<span class="sd"> dispatch_action: whether the [Element](/slackblocks/latest/reference/messages/elements) should trigger the</span>
<span class="sd"> element: an interactive [Element](/slackblocks/latest/reference/elements) (e.g. a text field).</span>
<span class="sd"> dispatch_action: whether the [Element](/slackblocks/latest/reference/elements) should trigger the</span>
<span class="sd"> sending of a `block_actions` payload.</span>
<span class="sd"> block_id: you can use this field to provide a deterministic identifier for the block.</span>
<span class="sd"> hint: an optional additional guide on what input the user should prodive.</span>
Expand Down Expand Up @@ -2066,10 +2066,10 @@ <h3 id="blocks.RichTextBlock" class="doc doc-heading">

<p>A RichTextBlock is used to provide easier rich text formatting
than standard markdown text (e.g. in a
<a href="/slackblocks/latest/reference/messages/blocks/#blocks.SectionBlock"><code>SectionBlock</code></a>)
<a href="/slackblocks/latest/reference/blocks/#blocks.SectionBlock"><code>SectionBlock</code></a>)
and access to text formatting features not available in traditional
markdown (e.g. strikethrough). See the various rich text elements
you can include <a href="/slackblocks/latest/reference/messages/rich_text">here</a>.</p>
you can include <a href="/slackblocks/latest/reference/rich_text">here</a>.</p>



Expand Down Expand Up @@ -2168,10 +2168,10 @@ <h3 id="blocks.RichTextBlock" class="doc doc-heading">
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A RichTextBlock is used to provide easier rich text formatting</span>
<span class="sd"> than standard markdown text (e.g. in a</span>
<span class="sd"> [`SectionBlock`](/slackblocks/latest/reference/messages/blocks/#blocks.SectionBlock))</span>
<span class="sd"> [`SectionBlock`](/slackblocks/latest/reference/blocks/#blocks.SectionBlock))</span>
<span class="sd"> and access to text formatting features not available in traditional</span>
<span class="sd"> markdown (e.g. strikethrough). See the various rich text elements</span>
<span class="sd"> you can include [here](/slackblocks/latest/reference/messages/rich_text).</span>
<span class="sd"> you can include [here](/slackblocks/latest/reference/rich_text).</span>

<span class="sd"> Args:</span>
<span class="sd"> elements: a single [rich text element](rich_text)</span>
Expand Down Expand Up @@ -2247,7 +2247,7 @@ <h3 id="blocks.SectionBlock" class="doc doc-heading">
it can be used as a simple text block, or with any of the
available block elements.</p>
<p>Section blocks can also optionally be given an "accessory,"
which is typically one of the interactive <a href="/slackblocks/latest/reference/messages/elements">Elements</a>.</p>
which is typically one of the interactive <a href="/slackblocks/latest/reference/elements">Elements</a>.</p>



Expand Down Expand Up @@ -2313,7 +2313,7 @@ <h3 id="blocks.SectionBlock" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>an optional <a href="/slackblocks/latest/reference/messages/elements">Element</a> object that will take a
<p>an optional <a href="/slackblocks/latest/reference/elements">Element</a> object that will take a
secondary place in the block (after or to the side of <code>text</code> or <code>fields</code>).</p>
</div>
</td>
Expand Down Expand Up @@ -2398,15 +2398,15 @@ <h3 id="blocks.SectionBlock" class="doc doc-heading">
<span class="sd"> available block elements.</span>

<span class="sd"> Section blocks can also optionally be given an &quot;accessory,&quot;</span>
<span class="sd"> which is typically one of the interactive [Elements](/slackblocks/latest/reference/messages/elements).</span>
<span class="sd"> which is typically one of the interactive [Elements](/slackblocks/latest/reference/elements).</span>

<span class="sd"> Args:</span>
<span class="sd"> text: text to include in the block. Can be a string or `Text` object (of either</span>
<span class="sd"> `mrkdwn` or `plaintext` variety). Defaults to markdown if unspecified. One of either</span>
<span class="sd"> `text` or `fields` must be provided.</span>
<span class="sd"> block_id: you can use this field to provide a deterministic identifier for the block.</span>
<span class="sd"> fields: a list of text objects. One of either `text` or `fields` must be provided.</span>
<span class="sd"> accessory: an optional [Element](/slackblocks/latest/reference/messages/elements) object that will take a</span>
<span class="sd"> accessory: an optional [Element](/slackblocks/latest/reference/elements) object that will take a</span>
<span class="sd"> secondary place in the block (after or to the side of `text` or `fields`).</span>

<span class="sd"> Throws:</span>
Expand Down
Loading

0 comments on commit 2a0f86c

Please sign in to comment.