forked from fetchai/cosmpy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
122 lines (113 loc) · 4.45 KB
/
mkdocs.yml
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
site_name: CosmPy
site_url: https://docs.fetch.ai/cosmpy
site_description: Everything you need to know about CosmPy.
repo_url: https://github.com/fetchai/cosmpy
edit_uri: ""
site_author: [email protected]
nav:
- Getting started: 'index.md'
- Beginner:
- Connect to a network: 'connect-to-network.md'
- Querying balances: 'query-balance.md'
- Wallets and Keys: 'wallets-and-keys.md'
- Send tokens: 'send-tokens.md'
- Staking: 'staking.md'
- Smart Contracts:
- Deploy a contract: 'deploy-a-contract.md'
- Advanced:
- Low-level API: 'low-level-api.md'
- Use-Cases:
- Stake Auto-Compounder: 'auto-compounder.md'
- Stake Optimizer: 'stake-optimizer.md'
- Oracles: 'oracles.md'
- Wallet Top-up: 'wallet-topup.md'
- Liquidity Pool: 'liquidity-pool.md'
- Swap Automation: 'swap-automation.md'
- API:
- Client:
- Client functionality: 'api/aerial/client/__init__.md'
- Bank send message: 'api/aerial/client/bank.md'
- Distribution: 'api/aerial/client/distribution.md'
- Staking functionality: 'api/aerial/client/staking.md'
- Helper functions: 'api/aerial/client/utils.md'
- Contract:
- Cosmwasm contract functionality: 'api/aerial/contract/__init__.md'
- Cosmwasm contract store, instantiate, execute messages: 'api/aerial/contract/cosmwasm.md'
- Parse the coins: 'api/aerial/coins.md'
- Network configurations: 'api/aerial/config.md'
- Exceptions: 'api/aerial/exceptions.md'
- Ledger faucet API interface: 'api/aerial/faucet.md'
- Transaction gas strategy: 'api/aerial/gas.md'
- Transaction helpers: 'api/aerial/tx_helpers.md'
- Transaction: 'api/aerial/tx.md'
- Parsing the URL: 'api/aerial/urls.md'
- Wallet Generation: 'api/aerial/wallet.md'
theme:
name: material
language: en
palette: # Set light/dark theme button next to the search bar
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
logo: assets/images/logo.png # Set Fetch Logo top left
favicon: assets/images/favicon.ico # Set Fetch favicon
features:
- navigation.instant # Fast page loading
- navigation.tracking # URL automatically updated with the currently active anchor
# - navigation.sections # Top level sections will be visible and grouped in sidebar
- navigation.top # Back-to-top button
- search.suggest # Completion for the searched word (can be accepted with ->).
- search.highlight # Highlight all occurrences after following a search result link
- search.share # Show share button for copying deep link to the current search query and result
# custom_dir: docs/overrides # Uncomment to enable announcements bar at the top
extra_css:
- css/my-styles.css
copyright: Copyright © 2018 - 2022 Fetch.ai # Copyright notice in footer
strict: true
markdown_extensions:
- admonition # Required by admonitions
- pymdownx.superfences # Required by admonitions, annotations, tabs. Enables arbitrary nesting of code and content blocks
- pymdownx.highlight: # Required by code blocks
anchor_linenums: true
- pymdownx.inlinehilite # Required by code blocks
- pymdownx.snippets # Required by code blocks
- pymdownx.superfences # Required by admonitions, code blocks
- pymdownx.details # Required by admonitions, code blocks
- attr_list # Required by annotations
- md_in_html # Required by annotations
- pymdownx.tabbed: # Required by tabs
alternate_style: true
- tables # # Required by tables
plugins:
- search # Enables search
extra:
generator: false
social:
- icon: fontawesome/brands/twitter
link: https://bit.ly/3oDuI3f
name: fetch.ai on twitter
- icon: fontawesome/brands/telegram
link: https://t.me/fetch_ai
name: fetch.ai on telegram
- icon: fontawesome/brands/discord
link: https://bit.ly/3ra5uMI
name: fetch.ai on discord
- icon: fontawesome/brands/github
link: https://bit.ly/3AFCWxl
name: fetch.ai on github
- icon: fontawesome/brands/reddit
link: https://bit.ly/30zS1Tg
name: fetch.ai on reddit
- icon: fontawesome/brands/youtube
link: https://bit.ly/3DxFazs
name: fetch.ai on youtube
- icon: fontawesome/brands/linkedin
link: https://bit.ly/3kNO70p
name: fetch.ai on linkedin