site_name: HUMAN Protocol Python SDK Docs

site_url: https://sdk.humanprotocol.org/python/

repo_name: humanprotocol/human-protocol

repo_url: https://github.com/humanprotocol/human-protocol

docs_dir: ../packages/sdk/python/human-protocol-sdk/docs

site_dir: python

theme:

name: material

custom_dir: overrides

logo: assets/img/logo.svg

favicon: assets/img/logo.svg

palette:

- scheme: default

primary: deep purple

accent: purple

toggle:

icon: material/brightness-7

name: Switch to dark mode

- scheme: slate

primary: deep purple

accent: purple

toggle:

icon: material/brightness-3

name: Switch to light mode

font:

text: Noto Sans

code: Roboto Mono

features:

- navigation.instant

- navigation.instant.prefetch

- navigation.top

- navigation.tracking

- navigation.path

- navigation.indexes

- navigation.prune

- content.tabs

- content.code.copy

- toc.follow

- announce.dismiss

extra:

language: python

version:

provider: mike

logo_href: https://sdk.humanprotocol.org

markdown_extensions:

- toc:

baselevel: 1

permalink: true

- admonition

- pymdownx.details

- pymdownx.superfences

- pymdownx.tabbed:

alternate_style: true

- pymdownx.highlight:

anchor_linenums: true

- pymdownx.magiclink

- attr_list

- md_in_html

plugins:

- search

- mkdocstrings:

handlers:

python:

paths: [../packages/sdk/python/human-protocol-sdk]

options:

docstring_style: google

show_source: false

separate_signature: true

merge_init_into_class: true

heading_level: 2

- mike

- section-index

nav:

- Overview: index.md

- Encryption:

- Encryption: encryption.md

- Encryption Utils: encryption_utils.md

- LegacyEncryption: legacy_encryption.md

- Escrow:

- EscrowClient: escrow_client.md

- EscrowUtils: escrow_utils.md

- KVStore:

- KVStoreClient: kvstore_client.md

- KVStoreUtils: kvstore_utils.md

- Operator:

- OperatorUtils: operator_utils.md

- Staking:

- StakingClient: staking_client.md

- StakingUtils: staking_utils.md

- Statistics:

- StatisticsUtils: statistics_utils.md

- Transaction:

- TransactionUtils: transaction_utils.md

- Worker:

- WorkerUtils: worker_utils.md

- Core utilities: core.md

- Changelog: CHANGELOG.md

extra_css:

- assets/css/custom.css