Update documentation

ApeWorX · Dec 6, 2024 · 2f22dc6 · 2f22dc6
1 parent 1149e4d
commit 2f22dc6
Show file tree

Hide file tree

Showing 28 changed files with 10 additions and 10 deletions.
diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree
diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree
diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree
diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree
diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree
diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree
diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree
diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree
diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree
diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/.doctrees/userguides/compile.doctree b/latest/.doctrees/userguides/compile.doctree
diff --git a/latest/.doctrees/userguides/quickstart.doctree b/latest/.doctrees/userguides/quickstart.doctree
diff --git a/latest/.doctrees/userguides/scripts.doctree b/latest/.doctrees/userguides/scripts.doctree
diff --git a/latest/_sources/userguides/compile.md.txt b/latest/_sources/userguides/compile.md.txt
@@ -121,7 +121,7 @@ vyper = compilers.get_compiler("vyper", settings=settings["vyper"])
 vyper.compile([Path("path/to/contract.vy")])
 
 solidity = compilers.get_compiler("solidity", settings=settings["solidity"])
-vyper.compile([Path("path/to/contract.sol")])
+solidity.compile([Path("path/to/contract.sol")])
 ```
 
 ## Compile Source Code

diff --git a/latest/_sources/userguides/scripts.md.txt b/latest/_sources/userguides/scripts.md.txt
@@ -138,7 +138,7 @@ Suppose the name of the script is `foobar`, you can run it via:
 ape run foobar
 ```
 
-Without specifying `--network`, the script with connect to your default network.
+Without specifying `--network`, the script will connect to your default network.
 Else, specify the network using the `--network` flag:
 
 ```shell

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -193,7 +193,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <dd><p>Filter the results by ecosystem</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>berachain | optimism | lens | ethereum | polynomial | geist | bsc | astar | fraxtal | base | oort | moonbeam | palm | gnosis | polygon-zkevm | linea | taiko | shape | zksync | avalanche | blast | unichain | arbitrum | crossfi | zora | xmtp | scroll | world-chain | celo | polygon | wemix | fantom | flow-evm | soneium | apechain | rootstock | metis | cronos-zkevm | zetachain | cronos | lumia | mantle | shibarium | kroma | bttc | abstract | xai</p>
+<dd class="field-odd"><p>polygon-zkevm | fantom | shibarium | scroll | lumia | moonbeam | zora | crossfi | polygon | cronos-zkevm | lens | palm | soneium | bttc | linea | fraxtal | celo | polynomial | blast | avalanche | kroma | taiko | zetachain | apechain | metis | world-chain | ethereum | gnosis | astar | geist | cronos | xai | shape | flow-evm | unichain | berachain | abstract | bsc | wemix | mantle | zksync | optimism | oort | base | arbitrum | xmtp | rootstock</p>
 </dd>
 </dl>
 </dd></dl>
@@ -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>chiado-fork | prism-fork | amoy | goerli-fork | minato-fork | mumbai | testnet | dev | curtis-fork | mainnet | mumbai-fork | opbnb | amoy-fork | puppynet | goerli | curtis | puppynet-fork | mainnet-fork | alfajores | holesky | hekla-fork | minato | moonbase | opbnb-testnet-fork | polter | sepolia-fork | testnet-fork | prism | hekla | nova-fork | dev-fork | holesky-fork | fuji-fork | chiado | fuji | opbnb-fork | local | cardona-fork | bartio | alfajores-fork | bartio-fork | moonbase-fork | moonriver-fork | donau | moonriver | nova | opbnb-testnet | polter-fork | donau-fork | sepolia | cardona</p>
+<dd class="field-odd"><p>nova-fork | opbnb-testnet | chiado | polter | goerli-fork | dev-fork | minato | cardona-fork | opbnb | local | testnet | sepolia-fork | prism-fork | donau | dev | cardona | fuji-fork | puppynet-fork | holesky-fork | goerli | hekla-fork | mumbai-fork | prism | moonbase-fork | bartio-fork | puppynet | minato-fork | donau-fork | holesky | moonriver | nova | fuji | amoy | alfajores | testnet-fork | sepolia | curtis | amoy-fork | alfajores-fork | opbnb-testnet-fork | opbnb-fork | polter-fork | chiado-fork | moonriver-fork | mumbai | hekla | mainnet-fork | moonbase | bartio | curtis-fork | mainnet</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/compile.html b/latest/userguides/compile.html
@@ -268,7 +268,7 @@ <h2>Settings<a class="headerlink" href="#settings" title="Link to this heading">
 </span><span data-line="11"><span class="n">vyper</span><span class="o">.</span><span class="n">compile</span><span class="p">([</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;path/to/contract.vy&quot;</span><span class="p">)])</span>
 </span><span data-line="12">
 </span><span data-line="13"><span class="n">solidity</span> <span class="o">=</span> <span class="n">compilers</span><span class="o">.</span><span class="n">get_compiler</span><span class="p">(</span><span class="s2">&quot;solidity&quot;</span><span class="p">,</span> <span class="n">settings</span><span class="o">=</span><span class="n">settings</span><span class="p">[</span><span class="s2">&quot;solidity&quot;</span><span class="p">])</span>
-</span><span data-line="14"><span class="n">vyper</span><span class="o">.</span><span class="n">compile</span><span class="p">([</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;path/to/contract.sol&quot;</span><span class="p">)])</span>
+</span><span data-line="14"><span class="n">solidity</span><span class="o">.</span><span class="n">compile</span><span class="p">([</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;path/to/contract.sol&quot;</span><span class="p">)])</span>
 </span></pre></div>
 </div>
 </section>

diff --git a/latest/userguides/quickstart.html b/latest/userguides/quickstart.html
@@ -182,7 +182,7 @@ <h1>Overview<a class="headerlink" href="#overview" title="Link to this heading">
 <section id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h2>
 <p>Read our <a class="reference external" href="https://docs.apeworx.io/ape/stable/">technical documentation</a> to get a deeper understanding of our open source Framework.</p>
-<p>Read our <a class="reference external" href="https://academy.apeworx.io/">academic platform</a> will help you master Ape Framework with tutorials and challenges.</p>
+<p>Read our <a class="reference external" href="https://academy.apeworx.io/">academic platform</a> which will help you master Ape Framework with tutorials and challenges.</p>
 </section>
 <section id="prerequisite">
 <h2>Prerequisite<a class="headerlink" href="#prerequisite" title="Link to this heading"></a></h2>

diff --git a/latest/userguides/scripts.html b/latest/userguides/scripts.html
@@ -283,7 +283,7 @@ <h2>Main Method Scripts<a class="headerlink" href="#main-method-scripts" title="
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">ape<span class="w"> </span>run<span class="w"> </span>foobar
 </span></pre></div>
 </div>
-<p>Without specifying <code class="docutils literal notranslate"><span class="pre">--network</span></code>, the script with connect to your default network.
+<p>Without specifying <code class="docutils literal notranslate"><span class="pre">--network</span></code>, the script will connect to your default network.
 Else, specify the network using the <code class="docutils literal notranslate"><span class="pre">--network</span></code> flag:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">ape<span class="w"> </span>run<span class="w"> </span>foobar<span class="w"> </span>--network<span class="w"> </span>polygon:amoy:alchemy
 </span></pre></div>