Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 12, 2024
1 parent be67c79 commit fadbee3
Show file tree
Hide file tree
Showing 26 changed files with 24 additions and 24 deletions.
Binary file modified latest/.doctrees/commands/networks.doctree
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_compile.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_ethereum.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_node.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_pm.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_test.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/api.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/cli.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/managers.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/plugins.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/dependencies.doctree
Binary file not shown.
12 changes: 6 additions & 6 deletions latest/_sources/userguides/dependencies.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,22 +73,22 @@ dependencies:

When using the `pypi:` key, dependencies are downloaded and extracted from PyPI using an HTTP requests library.

You can also specify the `python:` key for already-installed dependencies:
You can also specify the `site_package:` key for already-installed dependencies:

```yaml
dependencies:
- python: snekmate
- site_package: snekmate
config_override:
contracts_folder: .
```

Using `python:` requires the package to be installed in your `sys.path` (site-packages) folder, generally via `pip` or some other tool.
Using `site_package:` requires the package to be installed in your `sys.path` (site-packages) folder, generally via `pip` or some other tool.
The `contracts_folder` override, in this case, is often needed because the site-package does not have the root source-folder included.
Additionally, `python:` specified dependencies may also be lacking project-configuration files, such as the `ape-config.yaml`.
Additionally, `site_package:` specified dependencies may also be lacking project-configuration files, such as the `ape-config.yaml`.
Compilers such as `vyper` encourage users to use `pip` to publish and install smart-contract dependencies (other vyper files), but some features in Ape may be limited if the dependency is not also specified in your config somewhere.

If wanting to use a dependency from `PyPI`, we recommend using the `pypi:` key instead of the `python:` key.
However, the `python:` key works great if you already used `pip` to install the dependency, especially if the dependency is not available on `PyPI`.
If wanting to use a dependency from `PyPI`, we recommend using the `pypi:` key instead of the `site_package:` key.
However, the `site_package:` key works great if you already used `pip` to install the dependency, especially if the dependency is not available on `PyPI`.

### Local

Expand Down
6 changes: 3 additions & 3 deletions latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>celo | apechain | bttc | kroma | shibarium | gnosis | world-chain | zetachain | polygon | cronos | geist | palm | unichain | arbitrum | fraxtal | rootstock | ethereum | lumia | fantom | crossfi | blast | cronos-zkevm | flow-evm | xai | polygon-zkevm | optimism | scroll | bsc | xmtp | polynomial | moonbeam | taiko | zksync | abstract | base | astar | metis | wemix | berachain | avalanche | soneium | mantle | lens | shape | zora | oort | linea</p>
<dd class="field-odd"><p>polygon-zkevm | base | crossfi | moonbeam | polygon | zksync | zora | flow-evm | taiko | shibarium | geist | fraxtal | gnosis | astar | bttc | kroma | cronos-zkevm | berachain | lens | optimism | ethereum | unichain | arbitrum | mantle | zetachain | linea | world-chain | apechain | bsc | polynomial | cronos | shape | abstract | soneium | avalanche | metis | blast | xmtp | fantom | xai | rootstock | oort | palm | celo | wemix | lumia | scroll</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -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>opbnb-testnet-fork | mainnet-fork | fuji | chiado-fork | alfajores-fork | amoy | donau-fork | holesky-fork | hekla-fork | sepolia | polter-fork | moonriver-fork | fuji-fork | donau | dev-fork | sepolia-fork | moonriver | cardona-fork | curtis-fork | opbnb-fork | puppynet-fork | testnet | nova-fork | chiado | testnet-fork | nova | local | cardona | dev | prism-fork | opbnb-testnet | mumbai-fork | moonbase-fork | holesky | curtis | hekla | alfajores | minato-fork | goerli | minato | goerli-fork | puppynet | bartio-fork | prism | opbnb | amoy-fork | bartio | mumbai | moonbase | polter | mainnet</p>
<dd class="field-odd"><p>prism-fork | dev | minato-fork | alfajores-fork | opbnb | goerli | sepolia-fork | chiado | polter | bartio | sepolia | moonriver-fork | moonbase-fork | local | moonriver | opbnb-testnet-fork | holesky-fork | puppynet-fork | goerli-fork | minato | bartio-fork | opbnb-fork | fuji | chiado-fork | hekla | polter-fork | mumbai | mainnet-fork | nova-fork | donau-fork | holesky | cardona | hekla-fork | amoy | mainnet | curtis-fork | puppynet | testnet-fork | donau | cardona-fork | nova | moonbase | curtis | dev-fork | opbnb-testnet | mumbai-fork | fuji-fork | testnet | prism | alfajores | amoy-fork</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -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>node | test</p>
<dd class="field-odd"><p>test | node</p>
</dd>
</dl>
</dd></dl>
Expand Down
4 changes: 2 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -3805,8 +3805,6 @@ <h2 id="P">P</h2>
<li><a href="commands/test.html#cmdoption-test-arg-PYTEST_ARGS">test command line option</a>
</li>
</ul></li>
<li><a href="methoddocs/ape_pm.html#ape_pm.dependency.PythonDependency.python">python (ape_pm.dependency.PythonDependency attribute)</a>
</li>
<li><a href="methoddocs/ape_pm.html#ape_pm.dependency.PythonDependency">PythonDependency (class in ape_pm.dependency)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -4155,6 +4153,8 @@ <h2 id="S">S</h2>
<li><a href="methoddocs/exceptions.html#ape.exceptions.SignatureError">SignatureError</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.misc.singledispatchmethod">singledispatchmethod (class in ape.utils.misc)</a>
</li>
<li><a href="methoddocs/ape_pm.html#ape_pm.dependency.PythonDependency.site_package">site_package (ape_pm.dependency.PythonDependency attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.providers.BlockAPI.size">size (ape.api.providers.BlockAPI property)</a>

Expand Down
Loading

0 comments on commit fadbee3

Please sign in to comment.