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 Oct 15, 2024
1 parent b455a03 commit 8e02ba0
Show file tree
Hide file tree
Showing 67 changed files with 3,633 additions and 149 deletions.
2 changes: 1 addition & 1 deletion index.html
View file
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=./latest/">
<meta http-equiv="refresh" content="0; URL=./latest/userguides/quickstart.html">
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/index.doctree
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/ape_accounts.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_compile.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_ethereum.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_node.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_pm.doctree
View file
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_test.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.
79 changes: 76 additions & 3 deletions latest/commands/accounts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en" data-accent-color="lime" data-content_root="../">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>accounts - ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>accounts - ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="compile" href="compile.html" /><link rel="prev" title="Logging" href="../userguides/logging.html" />
<link rel="canonical" href="ape/commands/accounts.html" /><script>
function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
setColorMode(localStorage._theme||"auto");
Expand Down Expand Up @@ -57,7 +57,66 @@
<aside id="lside" class="sy-lside md:w-72 md:shrink-0 print:hidden">
<div class="sy-lside-inner md:sticky">
<div class="sy-scrollbar p-6">
<div class="globaltoc" data-expand-depth="0">
<div class="globaltoc" data-expand-depth="0"><p class="caption" role="heading" aria-level="3"><span class="caption-text">User Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../userguides/quickstart.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/accounts.html">Accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/networks.html">Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/forking_networks.html">Forking Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/contracts.html">Contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/proxy.html">Proxy Contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/installing_plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/projects.html">Developing Projects with Ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/config.html">Configure Ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/compile.html">Compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/transactions.html">Transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/trace.html">Traces</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/scripts.html">Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/reverts.html">Reverts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/publishing.html">Publishing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/clis.html">CLIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/data.html">Querying Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/developing_plugins.html">Developing Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/logging.html">Logging</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">CLI Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="compile.html">compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">console</a></li>
<li class="toctree-l1"><a class="reference internal" href="init.html">init</a></li>
<li class="toctree-l1"><a class="reference internal" href="networks.html">networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="pm.html">pm</a></li>
<li class="toctree-l1"><a class="reference internal" href="run.html">run</a></li>
<li class="toctree-l1"><a class="reference internal" href="test.html">test</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">Core Python Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape.html">ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/api.html">ape.api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/cli.html">ape.cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/contracts.html">ape.contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/exceptions.html">ape.exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/managers.html">ape.managers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/plugins.html">ape.plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/types.html">ape.types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/utils.html">ape.utils</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">Plugin Python Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_accounts.html">ape-accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_compile.html">ape-compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_ethereum.html">ape-ethereum</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_ethereum.html#module-ape_ethereum.multicall">ape-ethereum.multicall</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_node.html">ape-node</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_pm.html">ape-pm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_test.html">ape-test</a></li>
</ul>

</div>
</div>
</div>
Expand Down Expand Up @@ -287,7 +346,21 @@ <h2>list<a class="headerlink" href="#accounts-list" title="Link to this heading"
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</button><div class="navigation flex print:hidden"></div></div>
</button><div class="navigation flex print:hidden"><div class="navigation-prev">
<a href="../userguides/logging.html">
<i class="i-lucide chevron-left"></i>
<div class="page-info">
<span>Previous</span><div class="title">Logging</div></div>
</a>
</div><div class="navigation-next">
<a href="compile.html">
<div class="page-info">
<span>Next</span>
<div class="title">compile</div>
</div>
<i class="i-lucide chevron-right"></i>
</a>
</div></div></div>
</div>
</main>
</div>
Expand Down
79 changes: 76 additions & 3 deletions latest/commands/compile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en" data-accent-color="lime" data-content_root="../">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>compile - ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>compile - ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="console" href="console.html" /><link rel="prev" title="accounts" href="accounts.html" />
<link rel="canonical" href="ape/commands/compile.html" /><script>
function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
setColorMode(localStorage._theme||"auto");
Expand Down Expand Up @@ -57,7 +57,66 @@
<aside id="lside" class="sy-lside md:w-72 md:shrink-0 print:hidden">
<div class="sy-lside-inner md:sticky">
<div class="sy-scrollbar p-6">
<div class="globaltoc" data-expand-depth="0">
<div class="globaltoc" data-expand-depth="0"><p class="caption" role="heading" aria-level="3"><span class="caption-text">User Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../userguides/quickstart.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/accounts.html">Accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/networks.html">Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/forking_networks.html">Forking Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/contracts.html">Contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/proxy.html">Proxy Contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/installing_plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/projects.html">Developing Projects with Ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/config.html">Configure Ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/compile.html">Compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/transactions.html">Transactions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/trace.html">Traces</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/scripts.html">Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/reverts.html">Reverts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/publishing.html">Publishing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/clis.html">CLIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/data.html">Querying Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/developing_plugins.html">Developing Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userguides/logging.html">Logging</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">CLI Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="accounts.html">accounts</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">console</a></li>
<li class="toctree-l1"><a class="reference internal" href="init.html">init</a></li>
<li class="toctree-l1"><a class="reference internal" href="networks.html">networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="pm.html">pm</a></li>
<li class="toctree-l1"><a class="reference internal" href="run.html">run</a></li>
<li class="toctree-l1"><a class="reference internal" href="test.html">test</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">Core Python Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape.html">ape</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/api.html">ape.api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/cli.html">ape.cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/contracts.html">ape.contracts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/exceptions.html">ape.exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/managers.html">ape.managers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/plugins.html">ape.plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/types.html">ape.types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/utils.html">ape.utils</a></li>
</ul>
<p class="caption" role="heading" aria-level="3"><span class="caption-text">Plugin Python Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_accounts.html">ape-accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_compile.html">ape-compile</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_ethereum.html">ape-ethereum</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_ethereum.html#module-ape_ethereum.multicall">ape-ethereum.multicall</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_node.html">ape-node</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_pm.html">ape-pm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../methoddocs/ape_test.html">ape-test</a></li>
</ul>

</div>
</div>
</div>
Expand Down Expand Up @@ -155,7 +214,21 @@ <h1>compile<a class="headerlink" href="#compile" title="Link to this heading">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</button><div class="navigation flex print:hidden"></div></div>
</button><div class="navigation flex print:hidden"><div class="navigation-prev">
<a href="accounts.html">
<i class="i-lucide chevron-left"></i>
<div class="page-info">
<span>Previous</span><div class="title">accounts</div></div>
</a>
</div><div class="navigation-next">
<a href="console.html">
<div class="page-info">
<span>Next</span>
<div class="title">console</div>
</div>
<i class="i-lucide chevron-right"></i>
</a>
</div></div></div>
</div>
</main>
</div>
Expand Down
Loading

0 comments on commit 8e02ba0

Please sign in to comment.