Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 4, 2024
1 parent 717d27d commit eb9c9ee
Show file tree
Hide file tree
Showing 198 changed files with 32,861 additions and 10 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: 0d8bff9d240ffda02270a66110e93b70
config: ace6460403cde73f52da3a0c56b9089c
tags: 645f666f9bcd5a90fca523b33c5a78b7
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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down
1 change: 1 addition & 0 deletions 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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down
7 changes: 4 additions & 3 deletions 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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down Expand Up @@ -247,7 +248,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>goerli-fork | mainnet | sepolia | local | goerli | sepolia-fork | mainnet-fork</p>
<dd class="field-odd"><p>local | goerli-fork | goerli | sepolia | mainnet-fork | mainnet | sepolia-fork</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -258,7 +259,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 | geth</p>
<dd class="field-odd"><p>geth | test</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -284,7 +285,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 | ::test | :local:test | ethereum::test | ethereum:local:test | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | :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 | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down
7 changes: 5 additions & 2 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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down Expand Up @@ -1564,14 +1565,14 @@ <h2 id="E">E</h2>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.estimate_gas_cost">estimate_gas_cost() (ape.api.providers.ProviderAPI method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.query.QueryAPI.estimate_query">estimate_query() (ape.api.query.QueryAPI method)</a>

<ul>
<li><a href="methoddocs/managers.html#ape.managers.query.DefaultQueryProvider.estimate_query">(ape.managers.query.DefaultQueryProvider method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/types.html#ape.types.BaseContractLog.event_arguments">event_arguments (ape.types.BaseContractLog attribute)</a>
</li>
<li><a href="methoddocs/types.html#ape.types.BaseContractLog.event_name">event_name (ape.types.BaseContractLog attribute)</a>
Expand All @@ -1593,6 +1594,8 @@ <h2 id="E">E</h2>
<li><a href="methoddocs/plugins.html#ape.plugins.network.ExplorerPlugin.explorers">explorers() (ape.plugins.network.ExplorerPlugin method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.extensions_with_missing_compilers">extensions_with_missing_compilers() (ape.managers.project.manager.ProjectManager method)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraAttributesMixin">ExtraAttributesMixin (class in ape.utils)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.projects.DependencyAPI.extract_manifest">extract_manifest() (ape.api.projects.DependencyAPI method)</a>

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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down
7 changes: 4 additions & 3 deletions 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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down Expand Up @@ -1501,7 +1502,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.EcosystemAPI">
<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">EcosystemAPI</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">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">fee_token_symbol</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">fee_token_decimals</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">18</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.networks.EcosystemAPI" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.ExtraAttributesMixin" title="ape.utils.basemodel.ExtraAttributesMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraAttributesMixin</span></code></a>, <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<p>A set of related networks, such as Ethereum.</p>
<dl class="py method">
<dt class="sig sig-object py" id="ape.api.networks.EcosystemAPI.__ape_extra_attributes__">
Expand Down Expand Up @@ -2394,7 +2395,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.projects.DependencyAPI">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.projects.</span></span><span class="sig-name descname"><span class="pre">DependencyAPI</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">version</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">contracts_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'contracts'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">['package.json',</span> <span class="pre">'package-lock.json',</span> <span class="pre">'**/.build/**/*.json']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_override</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><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.projects.DependencyAPI" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.ExtraAttributesMixin" title="ape.utils.basemodel.ExtraAttributesMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraAttributesMixin</span></code></a>, <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<p>A base-class for dependency sources, such as GitHub or IPFS.</p>
<dl class="py property">
<dt class="sig sig-object py" id="ape.api.projects.DependencyAPI.cached_manifest">
Expand Down Expand Up @@ -3332,7 +3333,7 @@ <h2>Transactions<a class="headerlink" href="#transactions" title="Permalink to t
<dl class="py class">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.transactions.</span></span><span class="sig-name descname"><span class="pre">ReceiptAPI</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">contract_address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChecksumAddress</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">block_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gas_used</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></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">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">txn_hash</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">transaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.transactions.TransactionAPI" title="ape.api.transactions.TransactionAPI"><span class="pre">TransactionAPI</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.ExtraAttributesMixin" title="ape.utils.basemodel.ExtraAttributesMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraAttributesMixin</span></code></a>, <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<p>An abstract class to represent a transaction receipt. The receipt
contains information about the transaction, such as the status
and required confirmations.</p>
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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</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.7.1">v0.7.1</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
Expand Down
Loading

0 comments on commit eb9c9ee

Please sign in to comment.