Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 3, 2024
1 parent b3f1b68 commit 46e2af6
Show file tree
Hide file tree
Showing 24 changed files with 68 additions and 8 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: 9d9d9e761ab49f0230fa3c9061fc0f62
config: dccafd6b0754b99ecaeaa6ad2ea4850c
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/ape_accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_compile.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_ethereum.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_node.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_pm.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_test.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.
4 changes: 2 additions & 2 deletions latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,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>local | mainnet | holesky | sepolia-fork | holesky-fork | sepolia | mainnet-fork</p>
<dd class="field-odd"><p>mainnet | local | sepolia-fork | holesky-fork | sepolia | holesky | mainnet-fork</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -307,7 +307,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
<dd><p>Filter the results by provider</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>test | node</p>
<dd class="field-odd"><p>node | test</p>
</dd>
</dl>
</dd></dl>
Expand Down
10 changes: 8 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1641,6 +1641,8 @@ <h2 id="C">C</h2>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexConverter.convert">(ape.managers.converters.HexConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter.convert">(ape.managers.converters.HexIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIterableConverter.convert">(ape.managers.converters.HexIterableConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.IntAddressConverter.convert">(ape.managers.converters.IntAddressConverter method)</a>
</li>
Expand Down Expand Up @@ -2413,6 +2415,8 @@ <h2 id="H">H</h2>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter">HexIntConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIterableConverter">HexIterableConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.address.BaseAddress.history">history (ape.api.address.BaseAddress property)</a>

Expand Down Expand Up @@ -2515,10 +2519,10 @@ <h2 id="I">I</h2>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.is_adhoc">is_adhoc (ape.api.networks.NetworkAPI property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/utils.html#ape.utils.is_array">is_array() (in module ape.utils)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.project.Project.is_compiled">is_compiled (ape.managers.project.Project property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.is_connected">is_connected (ape.api.providers.ProviderAPI property)</a>
Expand All @@ -2543,6 +2547,8 @@ <h2 id="I">I</h2>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexConverter.is_convertible">(ape.managers.converters.HexConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter.is_convertible">(ape.managers.converters.HexIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIterableConverter.is_convertible">(ape.managers.converters.HexIterableConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.IntAddressConverter.is_convertible">(ape.managers.converters.IntAddressConverter method)</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions latest/methoddocs/ape_node.html

Large diffs are not rendered by default.

54 changes: 54 additions & 0 deletions latest/methoddocs/managers.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,11 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.HexIntConverter.is_convertible"><code class="docutils literal notranslate"><span class="pre">HexIntConverter.is_convertible()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ape.managers.converters.HexIterableConverter"><code class="docutils literal notranslate"><span class="pre">HexIterableConverter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.HexIterableConverter.convert"><code class="docutils literal notranslate"><span class="pre">HexIterableConverter.convert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.HexIterableConverter.is_convertible"><code class="docutils literal notranslate"><span class="pre">HexIterableConverter.is_convertible()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ape.managers.converters.IntAddressConverter"><code class="docutils literal notranslate"><span class="pre">IntAddressConverter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.IntAddressConverter.convert"><code class="docutils literal notranslate"><span class="pre">IntAddressConverter.convert()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.converters.IntAddressConverter.is_convertible"><code class="docutils literal notranslate"><span class="pre">IntAddressConverter.is_convertible()</span></code></a></li>
Expand Down Expand Up @@ -2020,6 +2025,55 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ape.managers.converters.HexIterableConverter">
<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">HexIterableConverter</span></span><a class="headerlink" href="#ape.managers.converters.HexIterableConverter" title="Permalink to this definition"></a></dt>
<dd><p>Convert list of hex values to single concatenated <code class="docutils literal notranslate"><span class="pre">HexBytes</span></code> value.</p>
<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.converters.HexIterableConverter.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"><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">bytes</span></span></span><a class="headerlink" href="#ape.managers.converters.HexIterableConverter.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>
<p>Usage example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">ape</span> <span class="kn">import</span> <span class="n">convert</span>
<span class="kn">from</span> <span class="nn">ape.types</span> <span class="kn">import</span> <span class="n">AddressType</span>

<span class="n">convert</span><span class="p">(</span><span class="s2">&quot;1 gwei&quot;</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span>
<span class="c1"># 1000000000</span>

<span class="n">convert</span><span class="p">(</span><span class="s2">&quot;1 ETH&quot;</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span>
<span class="c1"># 1000000000000000000</span>

<span class="n">convert</span><span class="p">(</span><span class="s2">&quot;0x283Af0B28c62C092C9727F1Ee09c02CA627EB7F5&quot;</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span>
<span class="c1"># HexBytes(&#39;0x283af0b28c62c092c9727f1ee09c02ca627eb7f5&#39;)</span>

<span class="n">convert</span><span class="p">(</span><span class="s2">&quot;vitalik.eth&quot;</span><span class="p">,</span> <span class="n">AddressType</span><span class="p">)</span> <span class="c1"># with ape-ens plugin installed</span>
<span class="c1"># &#39;0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045&#39;</span>
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.converters.HexIterableConverter.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.HexIterableConverter.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>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ape.managers.converters.IntAddressConverter">
<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">IntAddressConverter</span></span><a class="headerlink" href="#ape.managers.converters.IntAddressConverter" 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 46e2af6

Please sign in to comment.