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 eace1cc commit 118c5f3
Show file tree
Hide file tree
Showing 17 changed files with 14 additions and 13 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: 4b97fea693a5f788a542085362c0db20
config: 6decfbb99a458d844edd2cf23fdef1e1
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.
4 changes: 2 additions & 2 deletions 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 | goerli-fork | sepolia-fork | local | goerli | mainnet-fork</p>
<dd class="field-odd"><p>mainnet | sepolia-fork | sepolia | local | goerli-fork | mainnet-fork | goerli</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -284,7 +284,7 @@ <h2>run<a class="headerlink" href="#networks-run" title="Permalink to this headi
<dd><p>Override the default network and provider. (see <cite>ape networks list</cite> for options)</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
<dd class="field-odd"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | :local:test | ethereum::test | ethereum:local:test | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1299,7 +1299,7 @@ <h2 id="C">C</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.providers.UpstreamProvider.connection_str">connection_str (ape.api.providers.UpstreamProvider property)</a>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.connection_str">connection_str (ape.api.providers.ProviderAPI property)</a>
</li>
<li>
console command line option
Expand Down
17 changes: 9 additions & 8 deletions latest/methoddocs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.config"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connect"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connection_id"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connection_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connection_str"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connection_str</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.data_folder"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.data_folder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.disconnect"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.disconnect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.estimate_gas_cost"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.estimate_gas_cost()</span></code></a></li>
Expand Down Expand Up @@ -475,7 +476,6 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ape.api.providers.UpstreamProvider"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.connection_str"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.connection_str</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.model_config"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.model_fields"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.model_fields</span></code></a></li>
</ul>
Expand Down Expand Up @@ -2759,6 +2759,14 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
providers of the same type, like multiple Geth –dev nodes.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.providers.ProviderAPI.connection_str">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connection_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ape.api.providers.ProviderAPI.connection_str" title="Permalink to this definition"></a></dt>
<dd><p>The str representing how to connect
to the node, such as an HTTP URL
or an IPC path.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.ProviderAPI.data_folder">
<span class="sig-name descname"><span class="pre">data_folder</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#ape.api.providers.ProviderAPI.data_folder" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3302,13 +3310,6 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.providers.</span></span><span class="sig-name descname"><span class="pre">UpstreamProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.networks.NetworkAPI" title="ape.api.networks.NetworkAPI"><span class="pre">NetworkAPI</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_page_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concurrency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.providers.UpstreamProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderAPI</span></code></a></p>
<p>A provider that can also be set as another provider’s upstream.</p>
<dl class="py property">
<dt class="sig sig-object py" id="ape.api.providers.UpstreamProvider.connection_str">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connection_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ape.api.providers.UpstreamProvider.connection_str" title="Permalink to this definition"></a></dt>
<dd><p>The str used by downstream providers to connect to this one.
For example, the URL for HTTP-based providers.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.UpstreamProvider.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.api.providers.UpstreamProvider.model_config" 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 118c5f3

Please sign in to comment.