Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 22, 2023
1 parent 59ca5a8 commit aad4151
Show file tree
Hide file tree
Showing 198 changed files with 31,968 additions and 6 deletions.
2 changes: 1 addition & 1 deletion stable/.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: a70b621a3bf511b71fc4f3ba6290a213
config: 24710759a6bda9c229d9755aaaacad04
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified stable/.doctrees/commands/console.doctree
Binary file not shown.
Binary file modified stable/.doctrees/commands/networks.doctree
Binary file not shown.
Binary file modified stable/.doctrees/environment.pickle
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/ape.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/api.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/cli.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/contracts.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/managers.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/plugins.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/utils.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions stable/commands/accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/compile.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
3 changes: 2 additions & 1 deletion stable/commands/console.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down Expand Up @@ -211,7 +212,7 @@ <h2>console<a class="headerlink" href="#console" title="Permalink to this headin
<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">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">&lt;function</span> <span class="pre">network_option.&lt;locals&gt;.fn</span> <span class="pre">at</span> <span class="pre">0x7f2176830c10&gt;</span></code></p>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">&lt;function</span> <span class="pre">network_option.&lt;locals&gt;.fn</span> <span class="pre">at</span> <span class="pre">0x7f1833e7a5f0&gt;</span></code></p>
</dd>
<dt class="field-even">Options<span class="colon">:</span></dt>
<dd class="field-even"><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>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/init.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
3 changes: 2 additions & 1 deletion stable/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down Expand Up @@ -243,7 +244,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>sepolia | goerli | mainnet-fork | mainnet | sepolia-fork | goerli-fork | local</p>
<dd class="field-odd"><p>mainnet | mainnet-fork | local | sepolia-fork | goerli | sepolia | goerli-fork</p>
</dd>
</dl>
</dd></dl>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/pm.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/run.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/test.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/ape.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
3 changes: 2 additions & 1 deletion stable/methoddocs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down Expand Up @@ -2081,7 +2082,7 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin

<dl class="py class">
<dt class="sig sig-object py" id="ape.api.networks.ProviderContextManager">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.networks.</span></span><span class="sig-name descname"><span class="pre">ProviderContextManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><span class="pre">ProviderAPI</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.networks.ProviderContextManager" title="Permalink 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">ape.api.networks.</span></span><span class="sig-name descname"><span class="pre">ProviderContextManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><span class="pre">ProviderAPI</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_on_exit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.networks.ProviderContextManager" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ManagerAccessMixin</span></code></p>
<p>A context manager for temporarily connecting to a network.
When entering the context, calls the <a class="reference internal" href="#ape.api.providers.ProviderAPI.connect" title="ape.api.providers.ProviderAPI.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ape.api.providers.ProviderAPI.connect()</span></code></a> method.
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/contracts.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
3 changes: 2 additions & 1 deletion stable/methoddocs/managers.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down Expand Up @@ -2330,7 +2331,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.networks.NetworkManager.parse_network_choice">
<span class="sig-name descname"><span class="pre">parse_network_choice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_choice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="api.html#ape.api.networks.ProviderContextManager" title="ape.api.networks.ProviderContextManager"><span class="pre">ProviderContextManager</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.parse_network_choice" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">parse_network_choice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_choice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></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 class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disconnect_on_exit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="api.html#ape.api.networks.ProviderContextManager" title="ape.api.networks.ProviderContextManager"><span class="pre">ProviderContextManager</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.parse_network_choice" title="Permalink to this definition"></a></dt>
<dd><p>Parse a network choice into a context manager for managing a temporary
connection to a provider. See
<a class="reference internal" href="#ape.managers.networks.NetworkManager.get_network_choices" title="ape.managers.networks.NetworkManager.get_network_choices"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_network_choices()</span></code></a> for all
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
2 changes: 1 addition & 1 deletion stable/searchindex.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions stable/userguides/accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
1 change: 1 addition & 0 deletions stable/userguides/clis.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.25">v0.6.25</option>
<option value="v0.6.24">v0.6.24</option>
<option value="v0.6.23">v0.6.23</option>
<option value="v0.6.22">v0.6.22</option>
Expand Down
Loading

0 comments on commit aad4151

Please sign in to comment.