Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 21, 2024
1 parent e74d13d commit 6c1f1ec
Show file tree
Hide file tree
Showing 22 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<!DOCTYPE html>
<meta charset="utf-8">
<title>Redirecting...</title>
<meta http-equiv="refresh" content="0; URL=./stable/userguides/quickstart.html">
<meta http-equiv="refresh" content="0; URL=./latest/userguides/quickstart.html">
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.
2 changes: 1 addition & 1 deletion latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
<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>holesky | local | sepolia | mainnet-fork | holesky-fork | sepolia-fork | mainnet</p>
<dd class="field-odd"><p>mainnet | mainnet-fork | sepolia | sepolia-fork | local | holesky-fork | holesky</p>
</dd>
</dl>
</dd></dl>
Expand Down
4 changes: 2 additions & 2 deletions latest/methoddocs/ape_node.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions latest/methoddocs/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -556,14 +556,14 @@ <h1>ape.cli<a class="headerlink" href="#ape-cli" title="Link to this heading">

<dl class="py function">
<dt class="sig sig-object py" id="ape.cli.options.ape_cli_context">
<span class="sig-prename descclassname"><span class="pre">ape.cli.options.</span></span><span class="sig-name descname"><span class="pre">ape_cli_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default_log_level:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">~ape.logging.LogLevel</span> <span class="pre">=</span> <span class="pre">'INFO'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj_type:</span> <span class="pre">type</span> <span class="pre">=</span> <span class="pre">&lt;class</span> <span class="pre">'ape.cli.options.ApeCliContextObject'&gt;</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">Callable</span></span></span><a class="headerlink" href="#ape.cli.options.ape_cli_context" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">ape.cli.options.</span></span><span class="sig-name descname"><span class="pre">ape_cli_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default_log_level:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">~ape.logging.LogLevel</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj_type:</span> <span class="pre">type</span> <span class="pre">=</span> <span class="pre">&lt;class</span> <span class="pre">'ape.cli.options.ApeCliContextObject'&gt;</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">Callable</span></span></span><a class="headerlink" href="#ape.cli.options.ape_cli_context" title="Link to this definition"></a></dt>
<dd><p>A <code class="docutils literal notranslate"><span class="pre">click</span></code> context object with helpful utilities.
Use in your commands to get access to common utility features,
such as logging or accessing managers.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>default_log_level</strong> (str | int | <code class="xref py py-class docutils literal notranslate"><span class="pre">LogLevel</span></code>) – The log-level
<li><p><strong>default_log_level</strong> (str | int | <code class="xref py py-class docutils literal notranslate"><span class="pre">LogLevel</span></code> | None) – The log-level
value to pass to <a class="reference internal" href="#ape.cli.options.verbosity_option" title="ape.cli.options.verbosity_option"><code class="xref py py-meth docutils literal notranslate"><span class="pre">verbosity_option()</span></code></a>.</p></li>
<li><p><strong>obj_type</strong> (<em>Type</em>) – The context object type. Defaults to
<a class="reference internal" href="#ape.cli.options.ApeCliContextObject" title="ape.cli.options.ApeCliContextObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApeCliContextObject</span></code></a>. Sub-class
Expand Down Expand Up @@ -652,7 +652,7 @@ <h1>ape.cli<a class="headerlink" href="#ape-cli" title="Link to this heading">

<dl class="py function">
<dt class="sig sig-object py" id="ape.cli.options.verbosity_option">
<span class="sig-prename descclassname"><span class="pre">ape.cli.options.</span></span><span class="sig-name descname"><span class="pre">verbosity_option</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cli_logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ApeLogger</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">default</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">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">LogLevel</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">'INFO'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</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">Callable</span></span></span><a class="headerlink" href="#ape.cli.options.verbosity_option" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">ape.cli.options.</span></span><span class="sig-name descname"><span class="pre">verbosity_option</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cli_logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ApeLogger</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">default</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">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">LogLevel</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">callback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</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">Callable</span></span></span><a class="headerlink" href="#ape.cli.options.verbosity_option" title="Link to this definition"></a></dt>
<dd><p>A decorator that adds a <cite>–verbosity, -v</cite> option to the decorated
command.</p>
<dl class="field-list simple">
Expand Down
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 6c1f1ec

Please sign in to comment.