Update documentation

ApeWorX · Mar 8, 2024 · e7c883c · e7c883c
1 parent 7832827
commit e7c883c
Show file tree

Hide file tree

Showing 209 changed files with 35,679 additions and 12 deletions.
diff --git a/stable/.buildinfo b/stable/.buildinfo
@@ -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: 4309f1024d4d890d392967fc36dd1ce9
+config: 9e25f0b5175adeb390a99185ebf7abb7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/stable/.doctrees/commands/networks.doctree b/stable/.doctrees/commands/networks.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/ape.doctree b/stable/.doctrees/methoddocs/ape.doctree
diff --git a/stable/.doctrees/methoddocs/ape_accounts.doctree b/stable/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/stable/.doctrees/methoddocs/api.doctree b/stable/.doctrees/methoddocs/api.doctree
diff --git a/stable/.doctrees/methoddocs/cli.doctree b/stable/.doctrees/methoddocs/cli.doctree
diff --git a/stable/.doctrees/methoddocs/contracts.doctree b/stable/.doctrees/methoddocs/contracts.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/managers.doctree b/stable/.doctrees/methoddocs/managers.doctree
diff --git a/stable/.doctrees/methoddocs/plugins.doctree b/stable/.doctrees/methoddocs/plugins.doctree
diff --git a/stable/.doctrees/methoddocs/types.doctree b/stable/.doctrees/methoddocs/types.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/accounts.doctree b/stable/.doctrees/userguides/accounts.doctree
diff --git a/stable/_sources/userguides/accounts.md.txt b/stable/_sources/userguides/accounts.md.txt
@@ -181,7 +181,7 @@ If you do not use the `--hd-path` option, Ape will use the default HDPath of (Et
 You can import an account programatically using a seed phrase [using `import_account_from_mnemonic()`](../methoddocs/ape_accounts.html#ape_accounts.import_account_from_mnemonic):
 
 ```python
-from ape_acounts import import_account_from_mnemonic
+from ape_accounts import import_account_from_mnemonic
 
 alias = "my-account"
 passphrase = "my$ecurePassphrase"
@@ -196,7 +196,7 @@ Or using a raw private key [using `import_account_from_private_key()`](../method
 
 ```python
 import os
-from ape_acounts import import_account_from_private_key
+from ape_accounts import import_account_from_private_key
 
 alias = "my-account"
 passphrase = "my SecurePassphrase"

diff --git a/stable/commands/accounts.html b/stable/commands/accounts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/compile.html b/stable/commands/compile.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/console.html b/stable/commands/console.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/init.html b/stable/commands/init.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/networks.html b/stable/commands/networks.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
@@ -258,7 +259,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>mainnet-fork | goerli-fork | sepolia-fork | goerli | mainnet | local | sepolia</p>
+<dd class="field-odd"><p>sepolia | local | goerli-fork | mainnet | mainnet-fork | sepolia-fork | goerli</p>
 </dd>
 </dl>
 </dd></dl>
@@ -269,7 +270,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>geth | test</p>
+<dd class="field-odd"><p>test | geth</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/stable/commands/plugins.html b/stable/commands/plugins.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/pm.html b/stable/commands/pm.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/run.html b/stable/commands/run.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/commands/test.html b/stable/commands/test.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -47,6 +47,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
@@ -1435,6 +1436,8 @@ <h2 id="C">C</h2>
         <li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter.convert">(ape.managers.converters.HexIntConverter method)</a>
 </li>
         <li><a href="methoddocs/managers.html#ape.managers.converters.IntAddressConverter.convert">(ape.managers.converters.IntAddressConverter method)</a>
+</li>
+        <li><a href="methoddocs/managers.html#ape.managers.converters.StringDecimalConverter.convert">(ape.managers.converters.StringDecimalConverter method)</a>
 </li>
         <li><a href="methoddocs/managers.html#ape.managers.converters.StringIntConverter.convert">(ape.managers.converters.StringIntConverter method)</a>
 </li>
@@ -1484,6 +1487,10 @@ <h2 id="D">D</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/managers.html#ape.managers.config.ConfigManager.DATA_FOLDER">DATA_FOLDER (ape.managers.config.ConfigManager attribute)</a>
+</li>
+      <li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.debug_logs_lines">debug_logs_lines (ape.api.transactions.ReceiptAPI property)</a>
+</li>
+      <li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.debug_logs_typed">debug_logs_typed (ape.api.transactions.ReceiptAPI property)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.declare">declare() (ape.api.accounts.AccountAPI method)</a>
 </li>
@@ -1515,10 +1522,10 @@ <h2 id="D">D</h2>
         <li><a href="methoddocs/managers.html#ape.managers.networks.NetworkManager.default_ecosystem">(ape.managers.networks.NetworkManager property)</a>
 </li>
       </ul></li>
-      <li><a href="methoddocs/utils.html#ape.utils.StructParser.default_name">default_name (ape.utils.StructParser property)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/utils.html#ape.utils.StructParser.default_name">default_name (ape.utils.StructParser property)</a>
+</li>
       <li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.default_network_name">default_network_name (ape.api.networks.EcosystemAPI property)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.default_provider_name">default_provider_name (ape.api.networks.NetworkAPI property)</a>
@@ -1947,10 +1954,10 @@ <h2 id="I">I</h2>
 </li>
       <li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.is_connected">is_connected (ape.api.providers.ProviderAPI property)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/api.html#ape.api.address.BaseAddress.is_contract">is_contract (ape.api.address.BaseAddress property)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/api.html#ape.api.convert.ConverterAPI.is_convertible">is_convertible() (ape.api.convert.ConverterAPI method)</a>
 
       <ul>
@@ -1967,6 +1974,8 @@ <h2 id="I">I</h2>
         <li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter.is_convertible">(ape.managers.converters.HexIntConverter method)</a>
 </li>
         <li><a href="methoddocs/managers.html#ape.managers.converters.IntAddressConverter.is_convertible">(ape.managers.converters.IntAddressConverter method)</a>
+</li>
+        <li><a href="methoddocs/managers.html#ape.managers.converters.StringDecimalConverter.is_convertible">(ape.managers.converters.StringDecimalConverter method)</a>
 </li>
         <li><a href="methoddocs/managers.html#ape.managers.converters.StringIntConverter.is_convertible">(ape.managers.converters.StringIntConverter method)</a>
 </li>
@@ -2808,6 +2817,8 @@ <h2 id="S">S</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/exceptions.html#ape.exceptions.Abort.show">show() (ape.exceptions.Abort method)</a>
+</li>
+      <li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.show_debug_logs">show_debug_logs() (ape.api.transactions.ReceiptAPI method)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.sign_message">sign_message() (ape.api.accounts.AccountAPI method)</a>
 
@@ -2882,6 +2893,8 @@ <h2 id="S">S</h2>
       <li><a href="methoddocs/api.html#ape.api.providers.SubprocessProvider.stop">stop() (ape.api.providers.SubprocessProvider method)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.stream_response">stream_response() (in module ape.utils)</a>
+</li>
+      <li><a href="methoddocs/managers.html#ape.managers.converters.StringDecimalConverter">StringDecimalConverter (class in ape.managers.converters)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.converters.StringIntConverter">StringIntConverter (class in ape.managers.converters)</a>
 </li>

diff --git a/stable/index.html b/stable/index.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/methoddocs/ape.html b/stable/methoddocs/ape.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>

diff --git a/stable/methoddocs/ape_accounts.html b/stable/methoddocs/ape_accounts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.10">v0.7.10</option>
                 <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>