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 26, 2023
1 parent 6f8729b commit 8d89ad6
Show file tree
Hide file tree
Showing 20 changed files with 109 additions and 50 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: c0c2b0517446238c9dbcdb8987e864b2
config: 10c53e12e6a58b391828cb0b38042b84
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/commands/console.doctree
Binary file not shown.
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/console.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h2>console<a class="headerlink" href="#console" title="Permalink to this headin
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">ethereum</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 | ethereum:local:test | ::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
<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 | ::geth | ethereum:local:geth | ::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
</dd>
</dl>
</dd></dl>
Expand Down
4 changes: 2 additions & 2 deletions latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,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-fork | goerli-fork | local | sepolia-fork | mainnet | goerli | sepolia</p>
<dd class="field-odd"><p>mainnet-fork | sepolia | sepolia-fork | local | mainnet | goerli-fork | goerli</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -278,7 +278,7 @@ <h2>run<a class="headerlink" href="#networks-run" title="Permalink to this headi
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">ethereum:local:geth</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 | ethereum:local:test | ::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
<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 | ::geth | ethereum:local:geth | ::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
</dd>
</dl>
</dd></dl>
Expand Down
40 changes: 28 additions & 12 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,8 @@ <h2 id="Symbols">Symbols</h2>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.__ape_extra_attributes__">__ape_extra_attributes__() (ape.api.networks.EcosystemAPI method)</a>
</li>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractInstance.__call__">__call__() (ape.contracts.base.ContractInstance method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.__contains__">__contains__() (ape.api.accounts.AccountContainerAPI method)</a>
Expand All @@ -566,11 +568,9 @@ <h2 id="_">_</h2>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractInstance.__dir__">(ape.contracts.base.ContractInstance method)</a>
</li>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.__getattr__">__getattr__() (ape.api.networks.EcosystemAPI method)</a>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractContainer.__getattr__">__getattr__() (ape.contracts.base.ContractContainer method)</a>

<ul>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractContainer.__getattr__">(ape.contracts.base.ContractContainer method)</a>
</li>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractInstance.__getattr__">(ape.contracts.base.ContractInstance method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.__getattr__">(ape.managers.project.manager.ProjectManager method)</a>
Expand All @@ -579,8 +579,6 @@ <h2 id="_">_</h2>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.__getitem__">__getitem__() (ape.api.accounts.AccountContainerAPI method)</a>

<ul>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.__getitem__">(ape.api.networks.EcosystemAPI method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.accounts.TestAccountManager.__getitem__">(ape.managers.accounts.TestAccountManager method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.BlockContainer.__getitem__">(ape.managers.chain.BlockContainer method)</a>
Expand Down Expand Up @@ -1126,6 +1124,8 @@ <h2 id="A">A</h2>
<li><a href="methoddocs/exceptions.html#ape.exceptions.ArgumentsLengthError">ArgumentsLengthError</a>
</li>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractContainer.at">at() (ape.contracts.base.ContractContainer method)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.attributes">attributes (ape.utils.ExtraModelAttributes attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.auto_gas_multiplier">auto_gas_multiplier (ape.api.networks.NetworkAPI property)</a>
</li>
Expand Down Expand Up @@ -1381,8 +1381,12 @@ <h2 id="C">C</h2>
</li>
<li><a href="methoddocs/exceptions.html#ape.exceptions.ContractNotFoundError">ContractNotFoundError</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.contracts">contracts (ape.managers.project.manager.ProjectManager property)</a>
<li><a href="methoddocs/api.html#ape.api.projects.DependencyAPI.contracts">contracts (ape.api.projects.DependencyAPI property)</a>

<ul>
<li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.contracts">(ape.managers.project.manager.ProjectManager property)</a>
</li>
</ul></li>
<li><a href="methoddocs/utils.html#ape.utils.TraceStyles.CONTRACTS">CONTRACTS (ape.utils.TraceStyles attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.projects.DependencyAPI.contracts_folder">contracts_folder (ape.api.projects.DependencyAPI attribute)</a>
Expand Down Expand Up @@ -1591,14 +1595,14 @@ <h2 id="E">E</h2>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.estimate_gas_cost">(ape.api.providers.Web3Provider method)</a>
</li>
</ul></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 Down Expand Up @@ -1634,6 +1638,8 @@ <h2 id="E">E</h2>
</li>
</ul></li>
<li><a href="methoddocs/utils.html#ape.utils.extract_nested_value">extract_nested_value() (in module ape.utils)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes">ExtraModelAttributes (class in ape.utils)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -1691,7 +1697,11 @@ <h2 id="G">G</h2>
<li><a href="methoddocs/api.html#ape.api.config.GenericConfig">GenericConfig (class in ape.api.config)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.ContractCache.get">get() (ape.managers.chain.ContractCache method)</a>

<ul>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.get">(ape.utils.ExtraModelAttributes method)</a>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.accounts.AccountManager.get_accounts_by_type">get_accounts_by_type() (ape.managers.accounts.AccountManager method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.explorers.ExplorerAPI.get_address_url">get_address_url() (ape.api.explorers.ExplorerAPI method)</a>
Expand Down Expand Up @@ -1743,11 +1753,11 @@ <h2 id="G">G</h2>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractInstance.get_error_by_signature">get_error_by_signature() (ape.contracts.base.ContractInstance method)</a>
</li>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractInstance.get_event_by_signature">get_event_by_signature() (ape.contracts.base.ContractInstance method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.compilers.CompilerManager.get_imports">get_imports() (ape.managers.compilers.CompilerManager method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.compilers.CompilerManager.get_imports">get_imports() (ape.managers.compilers.CompilerManager method)</a>
</li>
<li><a href="methoddocs/cli.html#ape.cli.choices.NetworkChoice.get_metavar">get_metavar() (ape.cli.choices.NetworkChoice method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.get_method_selector">get_method_selector() (ape.api.networks.EcosystemAPI method)</a>
Expand Down Expand Up @@ -1869,6 +1879,10 @@ <h2 id="I">I</h2>
<li><a href="methoddocs/managers.html#ape.managers.config.CompilerConfig.ignore_files">ignore_files (ape.managers.config.CompilerConfig attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.ImpersonatedAccount">ImpersonatedAccount (class in ape.api.accounts)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.include_getattr">include_getattr (ape.utils.ExtraModelAttributes attribute)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.include_getitem">include_getitem (ape.utils.ExtraModelAttributes attribute)</a>
</li>
<li><a href="methoddocs/cli.html#ape.cli.options.incompatible_with">incompatible_with() (in module ape.cli.options)</a>
</li>
Expand Down Expand Up @@ -1907,10 +1921,10 @@ <h2 id="I">I</h2>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.is_connected">(ape.api.providers.Web3Provider property)</a>
</li>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.address.BaseAddress.is_contract">is_contract (ape.api.address.BaseAddress property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.address.BaseAddress.is_contract">is_contract (ape.api.address.BaseAddress property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.convert.ConverterAPI.is_convertible">is_convertible() (ape.api.convert.ConverterAPI method)</a>

<ul>
Expand Down Expand Up @@ -2141,6 +2155,8 @@ <h2 id="N">N</h2>
<li><a href="methoddocs/exceptions.html#ape.exceptions.CustomError.name">(ape.exceptions.CustomError property)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.ConfigManager.name">(ape.managers.config.ConfigManager attribute)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.name">(ape.utils.ExtraModelAttributes attribute)</a>
</li>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.network">network (ape.api.providers.ProviderAPI attribute)</a>
Expand Down
Loading

0 comments on commit 8d89ad6

Please sign in to comment.