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 Aug 29, 2023
1 parent 99bd534 commit d7d71b4
Show file tree
Hide file tree
Showing 201 changed files with 30,796 additions and 10 deletions.
2 changes: 1 addition & 1 deletion stable/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 0e57cf9c47abc0e04370ba40f9f8c685
config: c4c95852eed38ce1d0d6184ed26a985a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified stable/.doctrees/commands/console.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/commands/networks.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/ape.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/api.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/cli.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/contracts.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/exceptions.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/managers.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/plugins.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/types.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/utils.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/userguides/networks.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion stable/_sources/userguides/networks.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ geth:
If you would like to connect to a URI using the `geth` provider, you can specify a URI for the provider name in the `--network` option:

```bash
ape run script --network etheruem:mainnet:https://foo.bar
ape run script --network ethereum:mainnet:https://foo.bar
```

Additionally, if you want to connect to an unknown ecosystem or network, you can use the URI by itself.
Expand Down
1 change: 1 addition & 0 deletions stable/commands/accounts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/compile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
3 changes: 2 additions & 1 deletion stable/commands/console.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down Expand Up @@ -207,7 +208,7 @@ <h2>console<a class="headerlink" href="#console" title="Permalink to this headin
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">ethereum</span></code></p>
</dd>
<dt class="field-even">Options<span class="colon">:</span></dt>
<dd class="field-even"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | ethereum:local:geth | ::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
<dd class="field-even"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | ethereum:local:test | ::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
</dd>
</dl>
</dd></dl>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
5 changes: 3 additions & 2 deletions stable/commands/networks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down Expand Up @@ -236,7 +237,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 | local | goerli-fork | mainnet-fork | sepolia-fork | sepolia | goerli</p>
<dd class="field-odd"><p>goerli-fork | mainnet-fork | mainnet | local | sepolia-fork | sepolia | goerli</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -275,7 +276,7 @@ <h2>run<a class="headerlink" href="#networks-run" title="Permalink to this headi
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">ethereum:local:geth</span></code></p>
</dd>
<dt class="field-even">Options<span class="colon">:</span></dt>
<dd class="field-even"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | ethereum:local:geth | ::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
<dd class="field-even"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | ethereum:local:test | ::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
</dd>
</dl>
</dd></dl>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/plugins.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/pm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/run.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/test.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
19 changes: 16 additions & 3 deletions stable/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down Expand Up @@ -1831,10 +1832,10 @@ <h2 id="H">H</h2>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.BlockContainer.height">height (ape.managers.chain.BlockContainer property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexAddressConverter">HexAddressConverter (class in ape.managers.converters)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexConverter">HexConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter">HexIntConverter (class in ape.managers.converters)</a>
Expand All @@ -1843,6 +1844,12 @@ <h2 id="H">H</h2>

<ul>
<li><a href="methoddocs/managers.html#ape.managers.chain.ChainManager.history">(ape.managers.chain.ChainManager property)</a>
</li>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.http_uri">http_uri (ape.api.providers.ProviderAPI property)</a>

<ul>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.http_uri">(ape.api.providers.Web3Provider property)</a>
</li>
</ul></li>
</ul></td>
Expand Down Expand Up @@ -2856,11 +2863,17 @@ <h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.web3">web3 (ape.api.providers.Web3Provider property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider">Web3Provider (class in ape.api.providers)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider">Web3Provider (class in ape.api.providers)</a>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.ws_uri">ws_uri (ape.api.providers.ProviderAPI property)</a>

<ul>
<li><a href="methoddocs/api.html#ape.api.providers.Web3Provider.ws_uri">(ape.api.providers.Web3Provider property)</a>
</li>
</ul></li>
</ul></td>
</tr></table>

Expand Down
1 change: 1 addition & 0 deletions stable/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/ape.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.6.18">v0.6.18</option>
<option value="v0.6.17">v0.6.17</option>
<option value="v0.6.16">v0.6.16</option>
<option value="v0.6.15">v0.6.15</option>
Expand Down
Loading

0 comments on commit d7d71b4

Please sign in to comment.