chore: regen docs

algorandfoundation · Oct 5, 2023 · f179414 · f179414
1 parent a7530d1
commit f179414
Show file tree

Hide file tree

Showing 8 changed files with 2,519 additions and 17,998 deletions.
diff --git a/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt b/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt
@@ -135,11 +135,6 @@ orphan: true
     :parser: myst
     :summary:
     ```
-* - {py:obj}`TestNetDispenserApiClient <algokit_utils.dispenser_api.TestNetDispenserApiClient>`
-  - ```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient
-    :parser: myst
-    :summary:
-    ```
 * - {py:obj}`EnsureBalanceParameters <algokit_utils._ensure_funded.EnsureBalanceParameters>`
   - ```{autodoc2-docstring} algokit_utils._ensure_funded.EnsureBalanceParameters
     :parser: myst
@@ -185,6 +180,11 @@ orphan: true
     :parser: myst
     :summary:
     ```
+* - {py:obj}`TestNetDispenserApiClient <algokit_utils.dispenser_api.TestNetDispenserApiClient>`
+  - ```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient
+    :parser: myst
+    :summary:
+    ```
 * - {py:obj}`TransactionParameters <algokit_utils.models.TransactionParameters>`
   - ```{autodoc2-docstring} algokit_utils.models.TransactionParameters
     :parser: myst
@@ -1120,49 +1120,6 @@ Bases: {py:obj}`Exception`
 
 ```
 
-`````{py:class} TestNetDispenserApiClient(auth_token: str | None = None, request_timeout: int = DISPENSER_REQUEST_TIMEOUT)
-:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient
-
-```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient
-:parser: myst
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.__init__
-:parser: myst
-```
-
-````{py:method} fund(address: str, amount: int, asset_id: int) -> algokit_utils.dispenser_api.DispenserFundResponse
-:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.fund
-
-```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.fund
-:parser: myst
-```
-
-````
-
-````{py:method} get_limit(address: str) -> algokit_utils.dispenser_api.DispenserLimitResponse
-:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.get_limit
-
-```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.get_limit
-:parser: myst
-```
-
-````
-
-````{py:method} refund(refund_txn_id: str) -> None
-:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.refund
-
-```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.refund
-:parser: myst
-```
-
-````
-
-`````
-
 `````{py:class} EnsureBalanceParameters
 :canonical: algokit_utils._ensure_funded.EnsureBalanceParameters
 
@@ -1584,6 +1541,49 @@ Bases: {py:obj}`enum.Enum`
 
 ````
 
+`````{py:class} TestNetDispenserApiClient(auth_token: str | None = None, request_timeout: int = DISPENSER_REQUEST_TIMEOUT)
+:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient
+
+```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient
+:parser: myst
+```
+
+```{rubric} Initialization
+```
+
+```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.__init__
+:parser: myst
+```
+
+````{py:method} fund(address: str, amount: int, asset_id: int) -> algokit_utils.dispenser_api.DispenserFundResponse
+:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.fund
+
+```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.fund
+:parser: myst
+```
+
+````
+
+````{py:method} get_limit(address: str) -> algokit_utils.dispenser_api.DispenserLimitResponse
+:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.get_limit
+
+```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.get_limit
+:parser: myst
+```
+
+````
+
+````{py:method} refund(refund_txn_id: str) -> None
+:canonical: algokit_utils.dispenser_api.TestNetDispenserApiClient.refund
+
+```{autodoc2-docstring} algokit_utils.dispenser_api.TestNetDispenserApiClient.refund
+:parser: myst
+```
+
+````
+
+`````
+
 `````{py:class} TransactionParameters
 :canonical: algokit_utils.models.TransactionParameters
 

diff --git a/docs/html/_sources/capabilities/transfer.md.txt b/docs/html/_sources/capabilities/transfer.md.txt
@@ -11,9 +11,9 @@ The key function to facilitate Algo transfers is `algokit.transfer(algod_client,
 
 The following fields on `TransferParameters` are required to transfer ALGOs:
 
--   `from_account`: The account or signer that will send the ALGOs
--   `to_address`: The address of the account that will receive the ALGOs
--   `micro_algos`: The amount of micro ALGOs to send
+- `from_account`: The account or signer that will send the ALGOs
+- `to_address`: The address of the account that will receive the ALGOs
+- `micro_algos`: The amount of micro ALGOs to send
 
 ## Ensuring minimum Algos
 
@@ -22,14 +22,14 @@ The function to facilitate this is `ensure_funded(client, parameters)`, which ta
 
 The following fields on `EnsureBalanceParameters` are required to ensure minimum ALGOs:
 
--   `account_to_fund`: The account address that will receive the ALGOs. This can be an `Account` instance, an `AccountTransactionSigner` instance, or a string.
--   `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement).
--   `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account). Default is 0.
--   `funding_source`: The account (with private key) or signer that will send the ALGOs. If not set, it will use `get_dispenser_account`. This can be an `Account` instance, an `AccountTransactionSigner` instance, [`TestNetDispenserApiClient`](https://github.com/algorandfoundation/algokit-utils-py/blob/main/docs/source/capabilities/dispenser-client.md) instance, or None.
--   `suggested_params`: (optional) Transaction parameters, an instance of `SuggestedParams`.
--   `note`: (optional) The transaction note, default is "Funding account to meet minimum requirement".
--   `fee_micro_algos`: (optional) The flat fee you want to pay, useful for covering extra fees in a transaction group or app call.
--   `max_fee_micro_algos`: (optional) The maximum fee that you are happy to pay (default: unbounded). If this is set it's possible the transaction could get rejected during network congestion.
+- `account_to_fund`: The account address that will receive the ALGOs. This can be an `Account` instance, an `AccountTransactionSigner` instance, or a string.
+- `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement).
+- `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account). Default is 0.
+- `funding_source`: The account (with private key) or signer that will send the ALGOs. If not set, it will use `get_dispenser_account`. This can be an `Account` instance, an `AccountTransactionSigner` instance, [`TestNetDispenserApiClient`](https://github.com/algorandfoundation/algokit-utils-py/blob/main/docs/source/capabilities/dispenser-client.md) instance, or None.
+- `suggested_params`: (optional) Transaction parameters, an instance of `SuggestedParams`.
+- `note`: (optional) The transaction note, default is "Funding account to meet minimum requirement".
+- `fee_micro_algos`: (optional) The flat fee you want to pay, useful for covering extra fees in a transaction group or app call.
+- `max_fee_micro_algos`: (optional) The maximum fee that you are happy to pay (default: unbounded). If this is set it's possible the transaction could get rejected during network congestion.
 
 The function calls Algod to find the current balance and minimum balance requirement, gets the difference between those two numbers and checks to see if it's more than the `min_spending_balance_micro_algos`. If so, it will send the difference, or the `min_funding_increment_micro_algos` if that is specified. If the account is on TestNet and `use_dispenser_api` is True, the [AlgoKit TestNet Dispenser API](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/dispenser.md) will be used to fund the account.
 
@@ -41,10 +41,10 @@ The key function to facilitate asset transfers is `transfer_asset(algod_client,
 
 The following fields on `TransferAssetParameters` are required to transfer assets:
 
--   `from_account`: The account or signer that will send the ALGOs
--   `to_address`: The address of the account that will receive the ALGOs
--   `asset_id`: The asset id that will be transfered
--   `amount`: The amount to send as the smallest divisible unit value
+- `from_account`: The account or signer that will send the ALGOs
+- `to_address`: The address of the account that will receive the ALGOs
+- `asset_id`: The asset id that will be transfered
+- `amount`: The amount to send as the smallest divisible unit value
 
 ## Dispenser