diff --git a/docs/api-network.rst b/docs/api-network.rst index 159c0a02d..1c910cca6 100644 --- a/docs/api-network.rst +++ b/docs/api-network.rst @@ -62,7 +62,7 @@ The ``main`` module contains methods for conncting to or disconnecting from the * If no argument is given, the current default is displayed. * If an integer value is given, this will be the default gas limit. - * If set to ``auto``, the gas limit is determined automatically via ``web3.eth.estimateGas``. + * If set to ``auto``, the gas limit is determined automatically via :meth:`web3.eth.estimateGas `. Returns ``False`` if the gas limit is set automatically, or an ``int`` if it is set to a fixed value. @@ -81,7 +81,7 @@ The ``main`` module contains methods for conncting to or disconnecting from the Gets and optionally sets the default gas price. * If an integer value is given, this will be the default gas price. - * If set to ``auto``, the gas price is determined automatically via ``web3.eth.getPrice``. + * If set to ``auto``, the gas price is determined automatically via :attr:`web3.eth.gasPrice `. Returns ``False`` if the gas price is set automatically, or an ``int`` if it is set to a fixed value. @@ -204,7 +204,7 @@ Account .. py:class:: brownie.network.account.Account - An ethereum address that you control the private key for, and so can send transactions from. Generated automatically from ``web3.eth.accounts`` and stored in the :func:`Accounts ` container. + An ethereum address that you control the private key for, and so can send transactions from. Generated automatically from :attr:`web3.eth.accounts ` and stored in the :func:`Accounts ` container. .. code-block:: python @@ -318,7 +318,7 @@ LocalAccount .. py:class:: brownie.network.account.LocalAccount - Functionally identical to :func:`Account `. The only difference is that a ``LocalAccount`` is one where the private key was directly inputted, and so is not found in ``web3.eth.accounts``. + Functionally identical to :func:`Account `. The only difference is that a ``LocalAccount`` is one where the private key was directly inputted, and so is not found in :attr:`web3.eth.accounts `. .. note:: Resetting the RPC client will delete all ``LocalAccount`` objects from the :func:`Account ` container. @@ -2122,16 +2122,16 @@ TransactionReceipt Methods ``brownie.network.web3`` ======================== -The ``web3`` module contains a slightly modified version of the web3.py ``Web3`` class that is used throughout various Brownie modules for RPC communication. +The ``web3`` module contains a slightly modified version of the web3.py :class:`Web3 ` class that is used throughout various Brownie modules for RPC communication. Web3 ---- -See the `Web3 API documentation `_ for detailed information on all the methods and attributes available here. This document only outlines methods that differ from the normal ``Web3`` public interface. +See the `Web3 API documentation `_ for detailed information on all the methods and attributes available here. This document only outlines methods that differ from the normal :class:`Web3 ` public interface. .. py:class:: brownie.network.web3.Web3 - Brownie subclass of ``Web3``. An instance is created at ``brownie.network.web3.web`` and available for import from the main package. + Brownie subclass of :class:`Web3 `. An instance is created at ``brownie.network.web3.web`` and available for import from the main package. .. code-block:: python diff --git a/docs/conf.py b/docs/conf.py index 1883e379f..30917c6d4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -196,4 +196,5 @@ def setup(sphinx): "hypothesis": ("https://hypothesis.readthedocs.io/en/latest", None), "pytest": ("https://docs.pytest.org/en/latest/", None), "python": ("https://docs.python.org/3.8/", None), + "web3py": ("https://web3py.readthedocs.io/en/stable/", None), } diff --git a/docs/core-contracts.rst b/docs/core-contracts.rst index 199bf7b8c..ed3637278 100644 --- a/docs/core-contracts.rst +++ b/docs/core-contracts.rst @@ -140,15 +140,15 @@ Transaction Parameters When executing a transaction to a contract, you can optionally include a :py:class:`dict ` of transaction parameters as the final input. It may contain the following values: * ``from``: the :func:`Account ` that the transaction it sent from. If not given, the transaction is sent from the account that deployed the contract. - * ``gas_limit``: The amount of gas provided for transaction execution, in wei. If not given, the gas limit is determined using ``web3.eth.estimateGas``. - * ``gas_price``: The gas price for the transaction, in wei. If not given, the gas price is set according to ``web3.eth.getPrice``. + * ``gas_limit``: The amount of gas provided for transaction execution, in wei. If not given, the gas limit is determined using :meth:`web3.eth.estimateGas `. + * ``gas_price``: The gas price for the transaction, in wei. If not given, the gas price is set according to :attr:`web3.eth.gasPrice `. * ``amount``: The amount of Ether to include with the transaction, in wei. All integer values can also be given as strings that will be converted by :func:`Wei `. .. note:: - To maintain compatibility with ``web3.eth.sendTransaction``, you can use ``gas``, ``gasPrice`` and ``value`` as aliases for ``gas_limit``, ``gas_price``, and ``amount``. + To maintain compatibility with :meth:`web3.eth.sendTransaction `, you can use ``gas``, ``gasPrice`` and ``value`` as aliases for ``gas_limit``, ``gas_price``, and ``amount``. Calls ----- diff --git a/docs/core-types.rst b/docs/core-types.rst index c655d8fdf..4b96899df 100644 --- a/docs/core-types.rst +++ b/docs/core-types.rst @@ -57,7 +57,7 @@ The :func:`Fixed ` class is used to handle Vype True -Attempting to assign, compare or perform arithmetic against a float raises a ``TypeError``. +Attempting to assign, compare or perform arithmetic against a float raises a :class:`TypeError`. .. code-block:: python