Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 20, 2023
1 parent dbeece2 commit 8e48ee3
Show file tree
Hide file tree
Showing 17 changed files with 65 additions and 3 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0b44102165a97053d1326ce4f4bbb17d
config: 4658bbad6e188594aa8ec365ca708ff4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/commands/networks.doctree
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/api.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/cli.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/managers.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/plugins.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
<dd><p>Filter the results by network</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>mainnet | sepolia-fork | goerli | local | goerli-fork | sepolia | mainnet-fork</p>
<dd class="field-odd"><p>goerli | local | mainnet-fork | sepolia-fork | mainnet | sepolia | goerli-fork</p>
</dd>
</dl>
</dd></dl>
Expand Down
10 changes: 10 additions & 0 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,8 @@ <h2 id="A">A</h2>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI">AccountContainerAPI (class in ape.api.accounts)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.AccountHistory">AccountHistory (class in ape.managers.chain)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter">AccountIntConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.accounts.AccountManager">AccountManager (class in ape.managers.accounts)</a>
</li>
Expand Down Expand Up @@ -1378,6 +1380,8 @@ <h2 id="C">C</h2>
<li><a href="methoddocs/cli.html#ape.cli.choices.PromptChoice.convert">(ape.cli.choices.PromptChoice method)</a>
</li>
<li><a href="methoddocs/cli.html#ape.cli.paramtype.AllFilePaths.convert">(ape.cli.paramtype.AllFilePaths method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.convert">(ape.managers.converters.AccountIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.convert">(ape.managers.converters.AddressAPIConverter method)</a>
</li>
Expand Down Expand Up @@ -1847,6 +1851,8 @@ <h2 id="I">I</h2>
<li><a href="methoddocs/api.html#ape.api.convert.ConverterAPI.is_convertible">is_convertible() (ape.api.convert.ConverterAPI method)</a>

<ul>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.is_convertible">(ape.managers.converters.AccountIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.is_convertible">(ape.managers.converters.AddressAPIConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.BytesAddressConverter.is_convertible">(ape.managers.converters.BytesAddressConverter method)</a>
Expand Down Expand Up @@ -2028,6 +2034,8 @@ <h2 id="M">M</h2>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfig.model_config">(ape.managers.config.DeploymentConfig attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfigCollection.model_config">(ape.managers.config.DeploymentConfigCollection attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.model_config">(ape.managers.converters.AccountIntConverter attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.model_config">(ape.managers.converters.AddressAPIConverter attribute)</a>
</li>
Expand Down Expand Up @@ -2134,6 +2142,8 @@ <h2 id="M">M</h2>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfig.model_fields">(ape.managers.config.DeploymentConfig attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfigCollection.model_fields">(ape.managers.config.DeploymentConfigCollection attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.model_fields">(ape.managers.converters.AccountIntConverter attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.model_fields">(ape.managers.converters.AddressAPIConverter attribute)</a>
</li>
Expand Down
52 changes: 52 additions & 0 deletions latest/methoddocs/managers.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,13 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-ape.managers.converters">Converters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#ape.managers.converters.AccountIntConverter"><code class="docutils literal notranslate"><span class="pre">AccountIntConverter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AccountIntConverter.convert"><code class="docutils literal notranslate"><span class="pre">AccountIntConverter.convert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AccountIntConverter.is_convertible"><code class="docutils literal notranslate"><span class="pre">AccountIntConverter.is_convertible()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AccountIntConverter.model_config"><code class="docutils literal notranslate"><span class="pre">AccountIntConverter.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AccountIntConverter.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountIntConverter.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ape.managers.converters.AddressAPIConverter"><code class="docutils literal notranslate"><span class="pre">AddressAPIConverter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AddressAPIConverter.convert"><code class="docutils literal notranslate"><span class="pre">AddressAPIConverter.convert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.AddressAPIConverter.is_convertible"><code class="docutils literal notranslate"><span class="pre">AddressAPIConverter.is_convertible()</span></code></a></li>
Expand Down Expand Up @@ -1785,6 +1792,51 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
</section>
<section id="module-ape.managers.converters">
<span id="converters"></span><h2>Converters<a class="headerlink" href="#module-ape.managers.converters" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="ape.managers.converters.AccountIntConverter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.managers.converters.</span></span><span class="sig-name descname"><span class="pre">AccountIntConverter</span></span><a class="headerlink" href="#ape.managers.converters.AccountIntConverter" title="Permalink to this definition"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="ape.managers.converters.AccountIntConverter.convert">
<span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="api.html#ape.api.address.BaseAddress" title="ape.api.address.BaseAddress"><span class="pre">BaseAddress</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#ape.managers.converters.AccountIntConverter.convert" title="Permalink to this definition"></a></dt>
<dd><p>Convert the given value to the type specified as the generic for this class.
Implementations of this API must throw a <a class="reference internal" href="exceptions.html#ape.exceptions.ConversionError" title="ape.exceptions.ConversionError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConversionError</span></code></a>
when the item fails to convert properly.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.converters.AccountIntConverter.is_convertible">
<span class="sig-name descname"><span class="pre">is_convertible</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#ape.managers.converters.AccountIntConverter.is_convertible" title="Permalink to this definition"></a></dt>
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if string value provided by <code class="docutils literal notranslate"><span class="pre">value</span></code> is convertible using
<a class="reference internal" href="api.html#ape.api.convert.ConverterAPI.convert" title="ape.api.convert.ConverterAPI.convert"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ape.api.convert.ConverterAPI.convert()</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> (<em>Any</em>) – The value to check.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">True</span></code> when the given value can be converted.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.managers.converters.AccountIntConverter.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arbitrary_types_allowed':</span> <span class="pre">True}</span></em><a class="headerlink" href="#ape.managers.converters.AccountIntConverter.model_config" title="Permalink to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.managers.converters.AccountIntConverter.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#ape.managers.converters.AccountIntConverter.model_fields" title="Permalink to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ape.managers.converters.AddressAPIConverter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.managers.converters.</span></span><span class="sig-name descname"><span class="pre">AddressAPIConverter</span></span><a class="headerlink" href="#ape.managers.converters.AddressAPIConverter" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 8e48ee3

Please sign in to comment.