Skip to content

Commit

Permalink
docs: bump documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aorumbayev committed Feb 21, 2025
1 parent 714c8e4 commit 3fe4b04
Show file tree
Hide file tree
Showing 11 changed files with 72 additions and 504 deletions.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d1acb0d0270d6bf9bfbb3d142ec2b085
config: 4f7050ca2baf67d0b4155492574876de
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/html/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4f7050ca2baf67d0b4155492574876de
config: d1acb0d0270d6bf9bfbb3d142ec2b085
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Classes
Module Contents
---------------

.. py:class:: OnSchemaBreak(*args, **kwds)
.. py:class:: OnSchemaBreak
Bases: :py:obj:`enum.Enum`

Expand Down Expand Up @@ -49,7 +49,7 @@ Module Contents



.. py:class:: OnUpdate(*args, **kwds)
.. py:class:: OnUpdate
Bases: :py:obj:`enum.Enum`

Expand Down Expand Up @@ -89,7 +89,7 @@ Module Contents



.. py:class:: OperationPerformed(*args, **kwds)
.. py:class:: OperationPerformed
Bases: :py:obj:`enum.Enum`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ Module Contents
...

Such classes are primarily used with static type checkers that recognize
structural subtyping (static duck-typing).

For example::
structural subtyping (static duck-typing), for example::

class C:
def meth(self) -> int:
Expand All @@ -48,7 +46,7 @@ Module Contents
only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
class GenProto(Protocol[T]):
def meth(self) -> T:
...

Expand Down Expand Up @@ -77,9 +75,7 @@ Module Contents
...

Such classes are primarily used with static type checkers that recognize
structural subtyping (static duck-typing).

For example::
structural subtyping (static duck-typing), for example::

class C:
def meth(self) -> int:
Expand All @@ -95,7 +91,7 @@ Module Contents
only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
class GenProto(Protocol[T]):
def meth(self) -> T:
...

Expand Down
6 changes: 3 additions & 3 deletions docs/html/autoapi/algokit_utils/applications/enums/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnSchemaBreak">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnSchemaBreak</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OnSchemaBreak" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnSchemaBreak</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OnSchemaBreak" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Action to take if an Application’s schema has breaking changes</p>
<dl class="py attribute">
Expand All @@ -367,7 +367,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to

<dl class="py class">
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnUpdate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnUpdate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OnUpdate" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OnUpdate</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OnUpdate" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Action to take if an Application has been updated</p>
<dl class="py attribute">
Expand Down Expand Up @@ -398,7 +398,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to

<dl class="py class">
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OperationPerformed">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OperationPerformed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#algokit_utils.applications.enums.OperationPerformed" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.enums.</span></span><span class="sig-name descname"><span class="pre">OperationPerformed</span></span><a class="headerlink" href="#algokit_utils.applications.enums.OperationPerformed" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>Describes the actions taken during deployment</p>
<dl class="py attribute">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -349,8 +349,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
</pre></div>
</div>
<p>Such classes are primarily used with static type checkers that recognize
structural subtyping (static duck-typing).</p>
<p>For example:</p>
structural subtyping (static duck-typing), for example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">C</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">0</span>
Expand All @@ -365,7 +364,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">[</span><span class="n">T</span><span class="p">](</span><span class="n">Protocol</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">(</span><span class="n">Protocol</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
<span class="o">...</span>
</pre></div>
Expand Down Expand Up @@ -394,8 +393,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
</pre></div>
</div>
<p>Such classes are primarily used with static type checkers that recognize
structural subtyping (static duck-typing).</p>
<p>For example:</p>
structural subtyping (static duck-typing), for example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">C</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">0</span>
Expand All @@ -410,7 +408,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">[</span><span class="n">T</span><span class="p">](</span><span class="n">Protocol</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">GenProto</span><span class="p">(</span><span class="n">Protocol</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">meth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
<span class="o">...</span>
</pre></div>
Expand Down
Loading

0 comments on commit 3fe4b04

Please sign in to comment.