Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx docs #464

Merged
merged 31 commits into from
Feb 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
8513a24
Add Sphinx dependency and basic sphinx setup
achow101 Aug 26, 2020
72316ee
Change bitcoin-core-usage.md to rst
achow101 Aug 26, 2020
c340c35
Move Coldcard docs to docstring.
achow101 Feb 17, 2021
073c935
Move bitbox01 docs to docstring
achow101 Feb 17, 2021
a717686
Move keepkey docs to docstring
achow101 Feb 17, 2021
2b99ca2
Move trezor docs to docstring
achow101 Feb 17, 2021
b23a4d3
Move ledger docs to docstring
achow101 Feb 17, 2021
6f95c02
Move bitbox02 docs to docstring
achow101 Feb 17, 2021
e3a0408
Move examples.md to examples.rst
achow101 Aug 26, 2020
436e89e
Move release-process.md to release-process.rst
achow101 Aug 26, 2020
55637ca
Add device support matrix doc and device notes
achow101 Aug 26, 2020
bd8a410
Move bitcoin-core-usage.rst and examples.rst to doc/examples/
achow101 Aug 26, 2020
bfbe83f
Move release-process.rst to docs/development/
achow101 Aug 26, 2020
41e2457
Add docs/usage and installation docs
achow101 Aug 26, 2020
01d7644
Docstring hwilib/commands.py
achow101 Feb 17, 2021
0277e5f
Add docstrings to udevinstaller.py
achow101 Feb 17, 2021
11fe5d1
Add public API documentation
achow101 Aug 27, 2020
9cadcc8
Add hwilib/hwwclient.py to sphinx docs
achow101 Feb 17, 2021
b209f36
docstring errors.py and add to api-usage.rst
achow101 Aug 27, 2020
46687af
Docstring descriptor.py and include in api-usage.rst
achow101 Aug 27, 2020
da818c5
Docstring base58.py
achow101 Aug 28, 2020
e47b8ed
Configure readthedocs.org
achow101 Aug 28, 2020
7e08931
Make RTD theme wider
achow101 Aug 28, 2020
1d2c21f
Add docs/usage/cli-usage.rst
achow101 Aug 26, 2020
ea692e6
Docstring hwilib/bech32.py
achow101 Feb 18, 2021
06b7ec3
Docstring hwilib/common.py
achow101 Feb 18, 2021
eff5405
Docstring hwilib/key.py
achow101 Feb 18, 2021
0dd535d
Docstring hwilib/psbt.py
achow101 Feb 23, 2021
12f0319
Docstring hwilib/_script.py
achow101 Feb 23, 2021
f82bc83
Docstring hwilib/_serialize.py
achow101 Feb 23, 2021
4b5792a
Add internal api to sphinx docs
achow101 Feb 23, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
version: 2

python:
install:
- requirements: docs/requirements.txt
34 changes: 2 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,41 +86,11 @@ pass the `--help` parameter after the command name; for example:

## Device Support

The below table lists what devices and features are supported for each device.

Please also see [docs](docs/) for additional information about each device.

* `✓` - supported by the firmware and implemented in HWI
* `✗` - supported by the firmware and not implemented in HWI
* `-` - not supported by the firmware

| Feature \ Device | Ledger Nano X | Ledger Nano S | Trezor One | Trezor Model T | BitBox01 | BitBox02 | KeepKey | Coldcard |
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| Support Planned | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Implemented | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| xpub retrieval | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Message Signing | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ |
| Device Setup | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | - |
| Device Wipe | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | - |
| Device Recovery | - | - | ✓ | ✓ | - | ✓ | ✓ | - |
| Device Backup | - | - | - | - | ✓ | ✓ | - | ✓ |
| P2PKH Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ |
| P2SH-P2WPKH Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| P2WPKH Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| P2SH Multisig Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| P2SH-P2WSH Multisig Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| P2WSH Multisig Inputs | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Bare Multisig Inputs | ✓ | ✓ | - | - | ✓ | - | - | - |
| Arbitrary scriptPubKey Inputs | ✓ | ✓ | - | - | ✓ | - | - | - |
| Arbitrary redeemScript Inputs | ✓ | ✓ | - | - | ✓ | - | - | - |
| Arbitrary witnessScript Inputs | ✓ | ✓ | - | - | ✓ | - | - | - |
| Non-wallet inputs | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ |
| Mixed Segwit and Non-Segwit Inputs | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Display on device screen | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ |
For documentation on devices supported and how they are supported, please check the [devicesupport page](docs/devices/index.rst)

## Using with Bitcoin Core

See [Using Bitcoin Core with Hardware Wallets](docs/bitcoin-core-usage.md).
See [Using Bitcoin Core with Hardware Wallets](docs/examples/bitcoin-core-usage.rst).

## License

Expand Down
8 changes: 8 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "!layout.html" %}
{% block footer %} {{ super() }}

<style>
.wy-nav-content { max-width: none; }
</style>

{% endblock %}
48 changes: 0 additions & 48 deletions docs/bitbox02.md

This file was deleted.