Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 24, 2024
1 parent 3ad8394 commit be68caf
Show file tree
Hide file tree
Showing 24 changed files with 32 additions and 9 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: 350223e9c009e6aa224c25ed6acc87d7
config: 99dfb19e0d6746ef5527876eaa285503
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/ape_accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_compile.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_ethereum.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_node.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_pm.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_test.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 @@ -292,7 +292,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>local | sepolia | mainnet-fork | holesky | mainnet | holesky-fork | sepolia-fork</p>
<dd class="field-odd"><p>local | sepolia-fork | mainnet-fork | sepolia | holesky-fork | mainnet | holesky</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -303,7 +303,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>node | test</p>
<dd class="field-odd"><p>test | node</p>
</dd>
</dl>
</dd></dl>
Expand Down
8 changes: 6 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3613,6 +3613,10 @@ <h2 id="R">R</h2>
<li><a href="methoddocs/types.html#ape.types.signatures.recover_signer">recover_signer() (ape.types.signatures method)</a>
</li>
<li><a href="methoddocs/ape_pm.html#ape_pm.GithubDependency.ref">ref (ape_pm.GithubDependency attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.SourceManager.refresh">refresh() (ape.managers.project.SourceManager method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.LocalProject.refresh_sources">refresh_sources() (ape.managers.project.LocalProject method)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.singledispatchmethod.register">register() (ape.utils.singledispatchmethod method)</a>

Expand All @@ -3628,14 +3632,14 @@ <h2 id="R">R</h2>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.remove">remove() (ape.api.accounts.AccountContainerAPI method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/ape_test.html#ape_test.CoverageConfig.reports">reports (ape_test.CoverageConfig attribute)</a>

<ul>
<li><a href="methoddocs/ape_test.html#ape_test.GasConfig.reports">(ape_test.GasConfig attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.request_header">request_header (ape.api.networks.EcosystemAPI attribute)</a>

<ul>
Expand Down
4 changes: 2 additions & 2 deletions latest/methoddocs/ape_node.html

Large diffs are not rendered by default.

21 changes: 20 additions & 1 deletion latest/methoddocs/managers.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.load_manifest"><code class="docutils literal notranslate"><span class="pre">LocalProject.load_manifest()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.meta"><code class="docutils literal notranslate"><span class="pre">LocalProject.meta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.project_api"><code class="docutils literal notranslate"><span class="pre">LocalProject.project_api</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.refresh_sources"><code class="docutils literal notranslate"><span class="pre">LocalProject.refresh_sources()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.reload_config"><code class="docutils literal notranslate"><span class="pre">LocalProject.reload_config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.sources"><code class="docutils literal notranslate"><span class="pre">LocalProject.sources</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.LocalProject.unpack"><code class="docutils literal notranslate"><span class="pre">LocalProject.unpack()</span></code></a></li>
Expand All @@ -477,6 +478,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.SourceManager.is_excluded"><code class="docutils literal notranslate"><span class="pre">SourceManager.is_excluded()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.SourceManager.lookup"><code class="docutils literal notranslate"><span class="pre">SourceManager.lookup()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.SourceManager.paths"><code class="docutils literal notranslate"><span class="pre">SourceManager.paths</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.SourceManager.refresh"><code class="docutils literal notranslate"><span class="pre">SourceManager.refresh()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -2431,7 +2433,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
<dd><p>Local contract-type loader. Only dict-like behavior is public.</p>
<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.ContractManager.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><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">compile_missing</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="contracts.html#ape.contracts.base.ContractContainer" title="ape.contracts.base.ContractContainer"><span class="pre">ContractContainer</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#ape.managers.project.ContractManager.get" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><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">compile_missing</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>, <em class="sig-param"><span class="n"><span class="pre">check_for_changes</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="contracts.html#ape.contracts.base.ContractContainer" title="ape.contracts.base.ContractContainer"><span class="pre">ContractContainer</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#ape.managers.project.ContractManager.get" title="Permalink to this definition"></a></dt>
<dd><p>Get a contract by name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -2440,6 +2442,8 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
<li><p><strong>compile_missing</strong> (<em>bool</em>) – Set to <code class="docutils literal notranslate"><span class="pre">False</span></code> to not attempt compiling
if the contract can’t be found. Note: modified sources are
re-compiled regardless of this flag.</p></li>
<li><p><strong>check_for_changes</strong> (<em>bool</em>) – Set to <code class="docutils literal notranslate"><span class="pre">False</span></code> if avoiding checking
for changes.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
Expand Down Expand Up @@ -2837,6 +2841,14 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
or a Brownie project (or something else).</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.LocalProject.refresh_sources">
<span class="sig-name descname"><span class="pre">refresh_sources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ape.managers.project.LocalProject.refresh_sources" title="Permalink to this definition"></a></dt>
<dd><p>Check for file-changes. Typically, you don’t need to call this method.
This method exists for when changing files mid-session, you can “refresh”
and Ape will know about the changes.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.LocalProject.reload_config">
<span class="sig-name descname"><span class="pre">reload_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ape.managers.project.LocalProject.reload_config" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3054,6 +3066,13 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
<dd><p>All contract sources paths.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.managers.project.SourceManager.refresh">
<span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ape.managers.project.SourceManager.refresh" title="Permalink to this definition"></a></dt>
<dd><p>Reset file-caches to handle session-changes.
(Typically not needed to be called by users).</p>
</dd></dl>

</dd></dl>

</section>
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 be68caf

Please sign in to comment.