kaspa-python-sdk/mkdocs.yml at main · smartgoo/kaspa-python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
site_name: Kaspa Python SDK
site_description: Kaspa Python SDK
site_url: https://kaspanet.github.io/kaspa-python-sdk/
repo_url: https://github.com/kaspanet/kaspa-python-sdk
repo_name: kaspa-python-sdk
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  favicon: assets/kaspa.png
  logo: assets/kaspa.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - navigation.path
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - scheme: default
      primary: teal
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - autorefs
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: alphabetical
            docstring_style: google
            docstring_section_style: spacy
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            show_if_no_docstring: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/external-links.js

watch:
  - python/kaspa/

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kaspanet/kaspa-python-sdk

copyright: Copyright &copy; 2022-2026 Kaspa developers

nav:
  - Getting Started:
      - index.md
      - Installation: getting-started/installation.md
      - Security: getting-started/security.md
  - Learn:
      - Overview: learn/index.md
      - Fundamentals:
          - Networks: learn/networks.md
          - Addresses: learn/addresses.md
      - RPC:
          - Overview: learn/rpc/overview.md
          - Connecting: learn/rpc/connecting.md
          - Resolver: learn/rpc/resolver.md
          - Calls: learn/rpc/calls.md
          - Subscriptions: learn/rpc/subscriptions.md
      - Wallet:
          - Overview: learn/wallet/overview.md
          - Architecture: learn/wallet/architecture.md
          - Lifecycle: learn/wallet/lifecycle.md
          - Wallet Files: learn/wallet/wallet-files.md
          - Private Keys: learn/wallet/private-keys.md
          - Accounts: learn/wallet/accounts.md
          - Addresses: learn/wallet/addresses.md
          - Send Transaction: learn/wallet/send-transaction.md
          - Sweep Funds: learn/wallet/sweep.md
          - Sync State: learn/wallet/sync-state.md
          - Events: learn/wallet/events.md
          - Transaction History: learn/wallet/transaction-history.md
          - Errors: learn/wallet/errors.md
      - Wallet SDK:
          - Overview: learn/wallet-sdk/overview.md
          - Key Management: learn/wallet-sdk/key-management.md
          - Derivation: learn/wallet-sdk/derivation.md
          - UTXO Processor: learn/wallet-sdk/utxo-processor.md
          - UTXO Context: learn/wallet-sdk/utxo-context.md
          - Transaction Generator: learn/wallet-sdk/tx-generator.md
      - Transactions:
          - Overview: learn/transactions/overview.md
          - Metadata Fields: learn/transactions/metadata.md
          - Inputs: learn/transactions/inputs.md
          - Outputs: learn/transactions/outputs.md
          - Mass & Fees: learn/transactions/mass-and-fees.md
          - Signing: learn/transactions/signing.md
          - Scripts: learn/transactions/scripts.md
          - Submission: learn/transactions/submission.md
          - Serialization: learn/transactions/serialization.md
  - Examples: examples.md
  - API Reference: reference/
  - Contributing:
      - Overview: contributing/index.md
      - Development Setup: contributing/setup.md
      - Building: contributing/building.md
      - Testing: contributing/testing.md
      - Documentation: contributing/documentation.md
      - Releasing: contributing/releasing.md
      - Architecture & Design: contributing/architecture-design.md
      - PyO3 Core Concepts: contributing/pyo3-core-concepts.md
  - Changelog: CHANGELOG.md