Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Nov 27, 2023
1 parent aad4151 commit bec6d9b
Show file tree
Hide file tree
Showing 56 changed files with 66 additions and 7 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
View file
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: 1254bf35e37634155dbca178f7eb6c1a
config: 47559767a1468b65d185acbb1804c351
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/commands/console.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/commands/networks.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/api.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/cli.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/contracts.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/managers.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/plugins.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
View file
Binary file not shown.
1 change: 1 addition & 0 deletions latest/commands/accounts.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/commands/compile.html
View file
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.26">v0.6.26</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>
Expand Down
5 changes: 3 additions & 2 deletions latest/commands/console.html
View file
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.26">v0.6.26</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>
Expand Down Expand Up @@ -212,10 +213,10 @@ <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">0x7f68f3c9a9e0&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">0x7f11fa642560&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 | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :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 | ::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
1 change: 1 addition & 0 deletions latest/commands/init.html
View file
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.26">v0.6.26</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>
Expand Down
7 changes: 4 additions & 3 deletions latest/commands/networks.html
View file
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.26">v0.6.26</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>
Expand Down Expand Up @@ -244,7 +245,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 | sepolia | mainnet | goerli | local | mainnet-fork | sepolia-fork</p>
<dd class="field-odd"><p>local | goerli-fork | sepolia-fork | sepolia | mainnet | goerli | mainnet-fork</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -255,7 +256,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 Down Expand Up @@ -283,7 +284,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 | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :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 | ::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
1 change: 1 addition & 0 deletions latest/commands/plugins.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/commands/pm.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/commands/run.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/commands/test.html
View file
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.26">v0.6.26</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>
Expand Down
3 changes: 3 additions & 0 deletions latest/genindex.html
View file
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.26">v0.6.26</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>
Expand Down Expand Up @@ -1749,6 +1750,8 @@ <h2 id="G">G</h2>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.get_code">(ape.api.providers.Web3Provider method)</a>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.get_compiler_data">get_compiler_data() (ape.managers.project.manager.ProjectManager method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.ConfigManager.get_config">get_config() (ape.managers.config.ConfigManager method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.ContractCache.get_container">get_container() (ape.managers.chain.ContractCache class method)</a>
Expand Down
1 change: 1 addition & 0 deletions latest/index.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/ape.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/api.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/cli.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/contracts.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/exceptions.html
View file
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.26">v0.6.26</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>
Expand Down
17 changes: 17 additions & 0 deletions latest/methoddocs/managers.html
View file
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.26">v0.6.26</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>
Expand Down Expand Up @@ -377,6 +378,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.dependencies"><code class="docutils literal notranslate"><span class="pre">ProjectManager.dependencies</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.extensions_with_missing_compilers"><code class="docutils literal notranslate"><span class="pre">ProjectManager.extensions_with_missing_compilers()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.extract_manifest"><code class="docutils literal notranslate"><span class="pre">ProjectManager.extract_manifest()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.get_compiler_data"><code class="docutils literal notranslate"><span class="pre">ProjectManager.get_compiler_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.get_contract"><code class="docutils literal notranslate"><span class="pre">ProjectManager.get_contract()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.get_project"><code class="docutils literal notranslate"><span class="pre">ProjectManager.get_project()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.interfaces_folder"><code class="docutils literal notranslate"><span class="pre">ProjectManager.interfaces_folder</span></code></a></li>
Expand Down Expand Up @@ -2506,6 +2508,21 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.manager.ProjectManager.get_compiler_data">
<span class="sig-name descname"><span class="pre">get_compiler_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compile_if_needed</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"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Compiler</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#ape.managers.project.manager.ProjectManager.get_compiler_data" title="Permalink to this definition"></a></dt>
<dd><p>A list of <code class="docutils literal notranslate"><span class="pre">Compiler</span></code> objects representing the raw-data specifics of a compiler.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>compile_if_needed</strong> (<em>bool</em>) – Set to <code class="docutils literal notranslate"><span class="pre">False</span></code> to only return cached compiler data.
Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List[Compiler]</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.manager.ProjectManager.get_contract">
<span class="sig-name descname"><span class="pre">get_contract</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contract_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><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="contracts.html#ape.contracts.base.ContractContainer" title="ape.contracts.base.ContractContainer"><span class="pre">ContractContainer</span></a></span></span><a class="headerlink" href="#ape.managers.project.manager.ProjectManager.get_contract" title="Permalink to this definition"></a></dt>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/plugins.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/types.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/methoddocs/utils.html
View file
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.26">v0.6.26</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>
Expand Down
Binary file modified latest/objects.inv
View file
Binary file not shown.
1 change: 1 addition & 0 deletions latest/py-modindex.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/search.html
View file
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.26">v0.6.26</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>
Expand Down
2 changes: 1 addition & 1 deletion latest/searchindex.js
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions latest/userguides/accounts.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/userguides/clis.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/userguides/compile.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/userguides/config.html
View file
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.26">v0.6.26</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>
Expand Down
1 change: 1 addition & 0 deletions latest/userguides/console.html
View file
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.26">v0.6.26</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>
Expand Down
Loading

0 comments on commit bec6d9b

Please sign in to comment.