Skip to content

Commit 558f5cb

Browse files
committed
chore: doc gen again
1 parent f7ad994 commit 558f5cb

File tree

9 files changed

+24
-34
lines changed

9 files changed

+24
-34
lines changed

docs/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: d1acb0d0270d6bf9bfbb3d142ec2b085
3+
config: ff13c5f34153f29e8728e11dcd3c0679
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/.buildinfo.bak

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: dde11509b3a7c658194a785d86df1e0e
3+
config: d1acb0d0270d6bf9bfbb3d142ec2b085
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/autoapi/algokit_utils/applications/enums/index.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Classes
1717
Module Contents
1818
---------------
1919

20-
.. py:class:: OnSchemaBreak(*args, **kwds)
20+
.. py:class:: OnSchemaBreak
2121
2222
Bases: :py:obj:`enum.Enum`
2323

@@ -49,7 +49,7 @@ Module Contents
4949

5050

5151

52-
.. py:class:: OnUpdate(*args, **kwds)
52+
.. py:class:: OnUpdate
5353
5454
Bases: :py:obj:`enum.Enum`
5555

@@ -89,7 +89,7 @@ Module Contents
8989

9090

9191

92-
.. py:class:: OperationPerformed(*args, **kwds)
92+
.. py:class:: OperationPerformed
9393
9494
Bases: :py:obj:`enum.Enum`
9595

docs/html/_sources/autoapi/algokit_utils/protocols/typed_clients/index.rst.txt

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ Module Contents
3030
...
3131

3232
Such classes are primarily used with static type checkers that recognize
33-
structural subtyping (static duck-typing).
34-
35-
For example::
33+
structural subtyping (static duck-typing), for example::
3634

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

51-
class GenProto[T](Protocol):
49+
class GenProto(Protocol[T]):
5250
def meth(self) -> T:
5351
...
5452

@@ -77,9 +75,7 @@ Module Contents
7775
...
7876

7977
Such classes are primarily used with static type checkers that recognize
80-
structural subtyping (static duck-typing).
81-
82-
For example::
78+
structural subtyping (static duck-typing), for example::
8379

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

98-
class GenProto[T](Protocol):
94+
class GenProto(Protocol[T]):
9995
def meth(self) -> T:
10096
...
10197

docs/html/autoapi/algokit_utils/applications/enums/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
342342
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading"></a></h2>
343343
<dl class="py class">
344344
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnSchemaBreak">
345-
<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>
345+
<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>
346346
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
347347
<p>Action to take if an Application’s schema has breaking changes</p>
348348
<dl class="py attribute">
@@ -367,7 +367,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
367367

368368
<dl class="py class">
369369
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OnUpdate">
370-
<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>
370+
<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>
371371
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
372372
<p>Action to take if an Application has been updated</p>
373373
<dl class="py attribute">
@@ -398,7 +398,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
398398

399399
<dl class="py class">
400400
<dt class="sig sig-object py" id="algokit_utils.applications.enums.OperationPerformed">
401-
<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>
401+
<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>
402402
<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
403403
<p>Describes the actions taken during deployment</p>
404404
<dl class="py attribute">

docs/html/autoapi/algokit_utils/protocols/typed_clients/index.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -349,8 +349,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
349349
</pre></div>
350350
</div>
351351
<p>Such classes are primarily used with static type checkers that recognize
352-
structural subtyping (static duck-typing).</p>
353-
<p>For example:</p>
352+
structural subtyping (static duck-typing), for example:</p>
354353
<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>
355354
<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>
356355
<span class="k">return</span> <span class="mi">0</span>
@@ -365,7 +364,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
365364
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
366365
only the presence of given attributes, ignoring their type signatures.
367366
Protocol classes can be generic, they are defined as:</p>
368-
<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>
367+
<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>
369368
<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>
370369
<span class="o">...</span>
371370
</pre></div>
@@ -394,8 +393,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
394393
</pre></div>
395394
</div>
396395
<p>Such classes are primarily used with static type checkers that recognize
397-
structural subtyping (static duck-typing).</p>
398-
<p>For example:</p>
396+
structural subtyping (static duck-typing), for example:</p>
399397
<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>
400398
<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>
401399
<span class="k">return</span> <span class="mi">0</span>
@@ -410,7 +408,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
410408
&#64;typing.runtime_checkable act as simple-minded runtime protocols that check
411409
only the presence of given attributes, ignoring their type signatures.
412410
Protocol classes can be generic, they are defined as:</p>
413-
<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>
411+
<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>
414412
<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>
415413
<span class="o">...</span>
416414
</pre></div>

docs/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/markdown/autoapi/algokit_utils/applications/enums/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Module Contents
1111

12-
### *class* algokit_utils.applications.enums.OnSchemaBreak(\*args, \*\*kwds)
12+
### *class* algokit_utils.applications.enums.OnSchemaBreak
1313

1414
Bases: `enum.Enum`
1515

@@ -27,7 +27,7 @@ Create a new Application and delete the old Application in a single transaction
2727

2828
Create a new Application
2929

30-
### *class* algokit_utils.applications.enums.OnUpdate(\*args, \*\*kwds)
30+
### *class* algokit_utils.applications.enums.OnUpdate
3131

3232
Bases: `enum.Enum`
3333

@@ -49,7 +49,7 @@ Create a new Application and delete the old Application in a single transaction
4949

5050
Create a new application
5151

52-
### *class* algokit_utils.applications.enums.OperationPerformed(\*args, \*\*kwds)
52+
### *class* algokit_utils.applications.enums.OperationPerformed
5353

5454
Bases: `enum.Enum`
5555

docs/markdown/autoapi/algokit_utils/protocols/typed_clients/index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ class Proto(Protocol):
2323
```
2424

2525
Such classes are primarily used with static type checkers that recognize
26-
structural subtyping (static duck-typing).
27-
28-
For example:
26+
structural subtyping (static duck-typing), for example:
2927

3028
```default
3129
class C:
@@ -44,7 +42,7 @@ only the presence of given attributes, ignoring their type signatures.
4442
Protocol classes can be generic, they are defined as:
4543

4644
```default
47-
class GenProto[T](Protocol):
45+
class GenProto(Protocol[T]):
4846
def meth(self) -> T:
4947
...
5048
```
@@ -68,9 +66,7 @@ class Proto(Protocol):
6866
```
6967

7068
Such classes are primarily used with static type checkers that recognize
71-
structural subtyping (static duck-typing).
72-
73-
For example:
69+
structural subtyping (static duck-typing), for example:
7470

7571
```default
7672
class C:
@@ -89,7 +85,7 @@ only the presence of given attributes, ignoring their type signatures.
8985
Protocol classes can be generic, they are defined as:
9086

9187
```default
92-
class GenProto[T](Protocol):
88+
class GenProto(Protocol[T]):
9389
def meth(self) -> T:
9490
...
9591
```

0 commit comments

Comments
 (0)