docs: document all public symbols (#13)

* docs: initial docs

* docs: document all public symbols

* chore: silence ruff for docs copyright configuration

* chore: remove autogenerated source

.gitignore

@@ -164,12 +164,7 @@ cython_debug/
 # macOS
 .DS_Store
 
-# we use this file for quickly editing run/debug args, it shouldn't be committed
-/args.in
-
-# Received approval test files
-*.received.*
-
 #Sphinx
 .doctrees/
-docs/cli/temp.md
+# ignore auto-generated sources
+/docs/source/apidocs

docs/source/conf.py

@@ -0,0 +1,73 @@
+from sphinx.domains.python import PythonDomain
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "algokit-utils"
+copyright = "2023, Algorand Foundation" # noqa: A001
+author = "Algorand Foundation"
+release = "1.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+ "sphinx.ext.githubpages",
+ "sphinx.ext.intersphinx",
+ "myst_parser",
+ "autodoc2",
+]
+templates_path = ["_templates"]
+exclude_patterns = []
+intersphinx_mapping = {
+ "python": ("https://docs.python.org/3", None),
+ "algosdk": ("https://py-algorand-sdk.readthedocs.io/en/latest", None),
+ "pyteal": ("https://pyteal.readthedocs.io/en/stable/", None),
+}
+# allows type aliases to be used as type references
+PythonDomain.object_types["data"].roles = ("data", "class", "obj")
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+
+
+# -- Options for myst ---
+myst_enable_extensions = [
+ "colon_fence",
+ "fieldlist",
+]
+
+
+# -- Options for autodoc2 ---
+autodoc2_packages = [
+ {
+ "path": "../../src/algokit_utils",
+ # "auto_mode": False,
+ },
+]
+autodoc2_skip_module_regexes = [r"algokit_utils\..*"]
+autodoc2_module_all_regexes = [
+ r"algokit_utils",
+]
+autodoc2_docstring_parser_regexes = [
+ # this will render all docstrings as Markdown
+ (r".*", "myst"),
+]
+autodoc2_hidden_objects = [
+ "undoc", # undocumented objects
+ "dunder", # double-underscore methods, e.g. __str__
+ "private", # single-underscore methods, e.g. _private
+ "inherited",
+]
+autodoc2_render_plugin = "myst"
+autodoc2_sort_names = True
+autodoc2_index_template = None

docs/source/index.md

@@ -0,0 +1,17 @@
+# Welcome to algokit-utils's documentation!
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+---
+
+usage
+apidocs/algokit_utils/algokit_utils
+```
+
+# Indices and tables
+
+* {ref}`genindex`
+* {ref}`modindex`
+* {ref}`search`

docs/source/usage.md

@@ -0,0 +1,17 @@
+# Usage
+
+## Installation
+
+To use algokit-utils, first install it using pip:
+
+```{code-block} console
+
+ (.venv) $ pip install algokit-utils
+```
+
+or alternatively add it to an existing poetry project
+
+```{code-block} console
+
+ (.venv) $ poetry add algokit-utils
+```

pyproject.toml

@@ -21,6 +21,12 @@ python-semantic-release = "*"
 pytest-cov = "*"
 pre-commit = "*"
 python-dotenv = "^1.0.0"
+sphinx = "^6.1.3"
+myst-parser = "^1.0.0"
+sphinx-copybutton = "^0.5.1"
+sphinx-rtd-theme = "^1.2.0"
+sphinx-autodoc2 = "^0.4.2"
+poethepoet = "^0.19.0"
 
 [build-system]
 requires = ["poetry-core"]
@@ -67,6 +73,9 @@ suppress-none-returning = true
 [tool.black]
 line-length = 120
 
+[tool.poe.tasks]
+docs = "sphinx-build docs/source docs/build"
+
 [tool.pytest.ini_options]
 pythonpath = ["src", "tests"]
 

src/algokit_utils/__init__.py

@@ -13,10 +13,12 @@
  get_sandbox_default_account,
 )
 from algokit_utils.application_client import (
+ ABIArgsDict,
  ABICallArgs,
  ABICallArgsDict,
  ABICreateCallArgs,
  ABICreateCallArgsDict,
+ ABIMethod,
  ApplicationClient,
  CommonCallParameters,
  CommonCallParametersDict,
@@ -32,7 +34,6 @@
 )
 from algokit_utils.application_specification import (
  ApplicationSpecification,
- AppSpecStateDict,
  CallConfig,
  DefaultArgumentDict,
  DefaultArgumentType,
@@ -53,6 +54,8 @@
  OnSchemaBreak,
  OnUpdate,
  OperationPerformed,
+ TemplateValueDict,
+ TemplateValueMapping,
  get_creator_apps,
  replace_template_variables,
 )
@@ -86,10 +89,12 @@
  "AppLookup",
  "get_creator_apps",
  "replace_template_variables",
+ "ABIArgsDict",
  "ABICallArgs",
  "ABICallArgsDict",
  "ABICreateCallArgs",
  "ABICreateCallArgsDict",
+ "ABIMethod",
  "CommonCallParameters",
  "CommonCallParametersDict",
  "CreateCallParameters",
@@ -101,13 +106,14 @@
  "OnUpdate",
  "OnSchemaBreak",
  "OperationPerformed",
+ "TemplateValueDict",
+ "TemplateValueMapping",
  "Program",
  "execute_atc_with_logic_error",
  "get_app_id_from_tx_id",
  "get_next_version",
  "num_extra_program_pages",
  "ApplicationSpecification",
- "AppSpecStateDict",
  "CallConfig",
  "DefaultArgumentDict",
  "DefaultArgumentType",

src/algokit_utils/_transfer.py

@@ -15,6 +15,8 @@
 
 @dataclasses.dataclass(kw_only=True)
 class TransferParameters:
+ """Parameters for transferring µALGOs between accounts"""
+
  from_account: Account | AccountTransactionSigner
  """The account (with private key) or signer that will send the µALGOs"""
  to_address: str
@@ -50,6 +52,8 @@ def _check_fee(transaction: PaymentTxn, max_fee: int | None) -> None:
 
 
 def transfer(client: AlgodClient, parameters: TransferParameters) -> PaymentTxn:
+ """Transfer µALGOs between accounts"""
+
  suggested_params = parameters.suggested_params or client.suggested_params()
  from_account = parameters.from_account
  sender = address_from_private_key(from_account.private_key) # type: ignore[no-untyped-call]

src/algokit_utils/account.py

@@ -16,12 +16,13 @@
 
 __all__ = [
  "create_kmd_wallet_account",
+ "get_account",
  "get_account_from_mnemonic",
- "get_or_create_kmd_wallet_account",
- "get_localnet_default_account",
  "get_dispenser_account",
  "get_kmd_wallet_account",
- "get_account",
+ "get_localnet_default_account",
+ "get_or_create_kmd_wallet_account",
+ "get_sandbox_default_account",
 ]
 
 logger = logging.getLogger(__name__)