Skip to content

Commit 719618c

Browse files
committed
Update: python-hdwallet docs & readme
1 parent 737c2da commit 719618c

6 files changed

Lines changed: 110 additions & 310 deletions

File tree

README.md

Lines changed: 82 additions & 281 deletions
Large diffs are not rendered by default.

docs/const.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/consts.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
===============
2+
Constant Values
3+
===============
4+
5+
.. autoclass:: hdwallet.consts.SLIP10_ED25519_CONST
6+
:members:
7+
8+
.. autoclass:: hdwallet.consts.KHOLAW_ED25519_CONST
9+
:members:
10+
11+
.. autoclass:: hdwallet.consts.SLIP10_SECP256K1_CONST
12+
:members:
13+
14+
.. autoclass:: hdwallet.consts.PUBLIC_KEY_TYPES
15+
:members:
16+
17+
.. autoclass:: hdwallet.consts.WIF_TYPES
18+
:members:
19+
20+
.. autoclass:: hdwallet.consts.SEMANTICS
21+
:members:
22+
23+
.. autoclass:: hdwallet.consts.MODES
24+
:members:

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Hierarchical Deterministic Wallet
2222
.. |Coverage Status| image:: https://coveralls.io/repos/github/hdwallet-io/python-hdwallet/badge.svg?branch=master
2323
:target: https://coveralls.io/github/hdwallet-io/python-hdwallet?branch=master
2424

25-
Python-based library for the implementation of a Hierarchical Deterministic (HD) Wallet generator supporting more than 200 cryptocurrencies.
26-
It allows the handling of multiple coins, multiple accounts, external and internal chains per account, and millions of addresses per chain.
25+
Python-based library implementing a Hierarchical Deterministic (HD) Wallet generator for 200+ cryptocurrencies.
2726

2827
.. epigraph::
2928

@@ -39,7 +38,7 @@ It allows the handling of multiple coins, multiple accounts, external and intern
3938
* - Components
4039
- Protocols
4140
* - Cryptocurrencies
42-
- `#supported-cryptocurrencies <cryptocurrencies.html>`_
41+
- `#supported-cryptocurrencies <https://hdwallet.io/cryptocurrencies>`_
4342
* - Entropies
4443
- ``Algorand``, ``BIP39``, ``Electrum-V1``, ``Electrum-V2``, ``Monero``
4544
* - Mnemonics
File renamed without changes.

docs/toctree.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ HDWallet
66
:maxdepth: 3
77

88
Overview <index.rst>
9-
install.rst
9+
installation.rst
1010
cli.rst
1111
Supported Cryptocurrencies <cryptocurrencies.rst>
1212

@@ -22,6 +22,6 @@ HDWallet
2222
HD's <hds.rst>
2323
Addresses <addresses.rst>
2424
HDWallet <hdwallet.rst>
25-
Consts <const.rst>
25+
Consts <consts.rst>
2626
Crypto <crypto.rst>
2727
Utils <utils.rst>

0 commit comments

Comments
 (0)