Skip to content

Commit 8b6878d

Browse files
antazoeyfubuloubu
andauthored
docs: fix build issues (ApeWorX#2544)
Co-authored-by: El De-dog-lo <[email protected]>
1 parent 9b81c12 commit 8b6878d

File tree

3 files changed

+9
-18
lines changed

3 files changed

+9
-18
lines changed

docs/index.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,25 @@
22
:plugin-prefix: ape_
33
:userguides:
44
- quickstart
5-
6-
# Getting Started with Your Project
75
- projects
86
- config
97
- installing_plugins
108
- dependencies
11-
12-
# Development Workflow
139
- accounts
1410
- compile
1511
- contracts
1612
- testing
1713
- reverts
18-
19-
# Deployment and Networks
2014
- networks
2115
- forking_networks
2216
- publishing
2317
- proxy
2418
- contract_metadata
25-
26-
# Interacting with Contracts
2719
- console
2820
- scripts
2921
- transactions
3022
- trace
31-
32-
# Debugging and Analysis
3323
- logging
3424
- data
35-
36-
# Customization
3725
- clis
3826
- developing_plugins

docs/userguides/contracts.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,13 @@ More information on publishing contracts can be found in [this guide](./publishi
9595

9696
You can also use the [at() method](../methoddocs/contracts.html#ape.contracts.base.ContractContainer.at) from the same top-level project manager when you know the address of an already-deployed contract:
9797

98-
````python
98+
```python
9999
from ape import project
100100

101101
contract = project.MyContract.at("0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45")
102102

103+
```
104+
103105
By default, Ape will detect if the contract is a proxy and use the implementation contract's interface. See the [Proxy Contracts guide](./proxy.html) for more details on proxy handling.
104106

105107
## From Any Address
@@ -110,7 +112,7 @@ If you already know the address of a contract, you can create instances of it us
110112
from ape import Contract
111113

112114
contract = Contract("0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45")
113-
````
115+
```
114116

115117
If the contract ABI and/or code is cached on disk or in memory (such as from a previous deploy or retrieval), it will use it.
116118
Otherwise, it will fetch the `ContractType` using the explorer plugin from the active network, such as [ape-etherscan](https://github.com/ApeWorX/ape-etherscan).
@@ -192,7 +194,7 @@ def main():
192194
Then, after you have a contract instance, you can call methods on the contract.
193195
For example, let's say you have a Vyper contract containing some functions:
194196

195-
```python
197+
```vyper
196198
wdAmount: public(uint256)
197199
198200
@pure

docs/userguides/scripts.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ By default, `cli` scripts do not have [`ape.cli.network_option`](../methoddocs/c
3838

3939
However, you can add the `network_option` or `ConnectedProviderCommand` to your scripts by importing them from the `ape.cli` namespace:
4040

41-
````python
41+
```python
4242
import click
4343
from ape.cli import ConnectedProviderCommand
4444

@@ -56,7 +56,8 @@ def cli(network, provider):
5656
click.echo(f"You are connected to network '{network.name}'.")
5757
click.echo(provider.chain_id)
5858

59-
59+
```
60+
6061
## Multi-Network Commands
6162

6263
Scripts can use the context manager for multi-network functionality.
@@ -93,7 +94,7 @@ def cli():
9394

9495
# Back to the original network
9596
print(f"Back to {network1}")
96-
````
97+
```
9798

9899
This pattern is especially useful for cross-chain operations, data gathering from multiple networks, or comparing state between networks.
99100

0 commit comments

Comments
 (0)