Update documentation

ApeWorX · Dec 4, 2024 · 25a992a · 25a992a
1 parent e519b48
commit 25a992a
Show file tree

Hide file tree

Showing 36 changed files with 4,423 additions and 93 deletions.
diff --git a/index.html b/index.html
@@ -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">
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/_sources/methoddocs/ape_accounts.md.txt b/latest/_sources/methoddocs/ape_accounts.md.txt
@@ -1,6 +1,6 @@
 # ape-accounts
 
 ```{eval-rst}
-.. automodule:: ape_accounts
+.. automodule:: ape_accounts.accounts
     :members:
 ```
diff --git a/latest/_sources/methoddocs/ape_compile.md.txt b/latest/_sources/methoddocs/ape_compile.md.txt
@@ -1,6 +1,6 @@
 # ape-compile
 
 ```{eval-rst}
-.. automodule:: ape_compile
+.. automodule:: ape_compile.config
     :members:
 ```
diff --git a/latest/_sources/methoddocs/ape_ethereum.md.txt b/latest/_sources/methoddocs/ape_ethereum.md.txt
@@ -1,7 +1,27 @@
 # ape-ethereum
 
 ```{eval-rst}
-.. automodule:: ape_ethereum
+.. automodule:: ape_ethereum.ecosystem
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_ethereum.provider
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_ethereum.proxies
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_ethereum.trace
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_ethereum.transactions
     :members:
 ```
 

diff --git a/latest/_sources/methoddocs/ape_node.md.txt b/latest/_sources/methoddocs/ape_node.md.txt
@@ -1,6 +1,6 @@
 # ape-node
 
 ```{eval-rst}
-.. automodule:: ape_node
+.. automodule:: ape_node.provider
     :members:
 ```
diff --git a/latest/_sources/methoddocs/ape_pm.md.txt b/latest/_sources/methoddocs/ape_pm.md.txt
@@ -1,6 +1,16 @@
 # ape-pm
 
 ```{eval-rst}
-.. automodule:: ape_pm
+.. automodule:: ape_pm.compiler
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_pm.dependency
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_pm.project
     :members:
 ```
diff --git a/latest/_sources/methoddocs/ape_test.md.txt b/latest/_sources/methoddocs/ape_test.md.txt
@@ -1,6 +1,16 @@
 # ape-test
 
 ```{eval-rst}
-.. automodule:: ape_test
+.. automodule:: ape_test.accounts
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_test.config
+    :members:
+```
+
+```{eval-rst}
+.. automodule:: ape_test.provider
     :members:
 ```
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>cronos-zkevm | kroma | unichain | bttc | cronos | celo | base | polygon | wemix | moonbeam | oort | gnosis | blast | shibarium | avalanche | ethereum | optimism | palm | linea | scroll | fraxtal | taiko | mantle | zksync | rootstock | xai | bsc | arbitrum | polygon-zkevm | fantom</p>
+<dd class="field-odd"><p>polygon-zkevm | scroll | palm | avalanche | unichain | zksync | kroma | wemix | polygon | xai | taiko | fraxtal | arbitrum | fantom | bttc | linea | base | blast | bsc | moonbeam | cronos | ethereum | oort | rootstock | optimism | celo | shibarium | mantle | gnosis | cronos-zkevm</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>hekla-fork | opbnb-testnet | moonriver-fork | opbnb-testnet-fork | donau | donau-fork | testnet | cardona-fork | mumbai-fork | moonbase | moonriver | sepolia-fork | goerli | holesky | opbnb-fork | goerli-fork | puppynet-fork | fuji | alfajores-fork | dev-fork | hekla | nova-fork | puppynet | nova | fuji-fork | moonbase-fork | dev | testnet-fork | cardona | opbnb | mainnet-fork | sepolia | holesky-fork | amoy | amoy-fork | mumbai | alfajores | local | mainnet</p>
+<dd class="field-odd"><p>sepolia | goerli-fork | donau-fork | hekla-fork | opbnb-testnet | fuji-fork | testnet-fork | opbnb | holesky-fork | nova-fork | cardona-fork | moonriver-fork | hekla | holesky | donau | cardona | amoy | opbnb-testnet-fork | mainnet-fork | sepolia-fork | puppynet | moonriver | goerli | dev-fork | mumbai | testnet | mainnet | puppynet-fork | alfajores-fork | fuji | moonbase-fork | local | dev | opbnb-fork | mumbai-fork | moonbase | amoy-fork | alfajores | nova</p>
 </dd>
 </dl>
 </dd></dl>
@@ -215,7 +215,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <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 | node</p>
+<dd class="field-odd"><p>node | test</p>
 </dd>
 </dl>
 </dd></dl>