Merge #471: Add walkthrough to sphinx generated docs

c603135 Move walkthrough into sphinx (Andrew Chow) Pull request description: Followup to #413. Moves the walkthrough doc under the examples directory and adds the file to the sphinx generated documentation. Top commit has no ACKs. Tree-SHA512: 96af0fa093f3035da3842fc7601d587ccb09ac4a89f93844ccdd345802f351abae0005ccb3fe06a88cea7aac543674fb81d37a8ded18c65abd9bf8981f341170
bitcoin-core · Feb 26, 2021 · 1f08345 · 1f08345
2 parents 1623f1c + c603135
commit 1f08345
Show file tree

Hide file tree

Showing 27 changed files with 3 additions and 5 deletions.
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -6,3 +6,4 @@ Example Usage
 
    bitcoin-core-usage
    examples
+   walkthrough/walkthrough
diff --git a/...-through/Screenshot01_HWI_Empty-State.png → ...kthrough/Screenshot01_HWI_Empty-State.png b/...-through/Screenshot01_HWI_Empty-State.png → ...kthrough/Screenshot01_HWI_Empty-State.png
diff --git a/...through/Screenshot02_HWI_HWW-Selected.png → ...through/Screenshot02_HWI_HWW-Selected.png b/...through/Screenshot02_HWI_HWW-Selected.png → ...through/Screenshot02_HWI_HWW-Selected.png
diff --git a/...enshot03-Core-Initial-Wallet-Overview.png → ...enshot03-Core-Initial-Wallet-Overview.png b/...enshot03-Core-Initial-Wallet-Overview.png → ...enshot03-Core-Initial-Wallet-Overview.png
diff --git a/...eenshot04_HWI_Address-Display-Request.png → ...eenshot04_HWI_Address-Display-Request.png b/...eenshot04_HWI_Address-Display-Request.png → ...eenshot04_HWI_Address-Display-Request.png
diff --git a/...eenshot05_HWW_Display-Receive-Address.png → ...eenshot05_HWW_Display-Receive-Address.png b/...eenshot05_HWW_Display-Receive-Address.png → ...eenshot05_HWW_Display-Receive-Address.png
diff --git a/...enshot06_HWI_Address-Display-Response.png → ...enshot06_HWI_Address-Display-Response.png b/...enshot06_HWI_Address-Display-Response.png → ...enshot06_HWI_Address-Display-Response.png
diff --git a/...eenshot07_Core_Console-getaddressinfo.png → ...eenshot07_Core_Console-getaddressinfo.png b/...eenshot07_Core_Console-getaddressinfo.png → ...eenshot07_Core_Console-getaddressinfo.png
diff --git a/...eenshot08_HWI_Address-Display-Request.png → ...eenshot08_HWI_Address-Display-Request.png b/...eenshot08_HWI_Address-Display-Request.png → ...eenshot08_HWI_Address-Display-Request.png
diff --git a/...reenshot09_HWW_Display-Change-Address.png → ...reenshot09_HWW_Display-Change-Address.png b/...reenshot09_HWW_Display-Change-Address.png → ...reenshot09_HWW_Display-Change-Address.png
diff --git a/...enshot10_HWI_Address-Display-Response.png → ...enshot10_HWI_Address-Display-Response.png b/...enshot10_HWI_Address-Display-Response.png → ...enshot10_HWI_Address-Display-Response.png
diff --git a/...eenshot11_Core_Console-getaddressinfo.png → ...eenshot11_Core_Console-getaddressinfo.png b/...eenshot11_Core_Console-getaddressinfo.png → ...eenshot11_Core_Console-getaddressinfo.png
diff --git a/...lk-through/Screenshot12_Core_Send-Tab.png → ...alkthrough/Screenshot12_Core_Send-Tab.png b/...lk-through/Screenshot12_Core_Send-Tab.png → ...alkthrough/Screenshot12_Core_Send-Tab.png
diff --git a/.../Screenshot13_Core_Create-Unsigned-Tx.png → .../Screenshot13_Core_Create-Unsigned-Tx.png b/.../Screenshot13_Core_Create-Unsigned-Tx.png → .../Screenshot13_Core_Create-Unsigned-Tx.png
diff --git a/...enshot14_Core_Paste-PSBT-to-Clipboard.png → ...enshot14_Core_Paste-PSBT-to-Clipboard.png b/...enshot14_Core_Paste-PSBT-to-Clipboard.png → ...enshot14_Core_Paste-PSBT-to-Clipboard.png
diff --git a/...k-through/Screenshot15_HWI_Empty-PSBT.png → ...lkthrough/Screenshot15_HWI_Empty-PSBT.png b/...k-through/Screenshot15_HWI_Empty-PSBT.png → ...lkthrough/Screenshot15_HWI_Empty-PSBT.png
diff --git a/...Screenshot16_HWI_Prepare-PSBT-signing.png → ...Screenshot16_HWI_Prepare-PSBT-signing.png b/...Screenshot16_HWI_Prepare-PSBT-signing.png → ...Screenshot16_HWI_Prepare-PSBT-signing.png
diff --git a/...shot17_HWW_Confirm-Amount-Destination.png → ...shot17_HWW_Confirm-Amount-Destination.png b/...shot17_HWW_Confirm-Amount-Destination.png → ...shot17_HWW_Confirm-Amount-Destination.png
diff --git a/...ugh/Screenshot18_HWW_Confirm-Locktime.png → ...ugh/Screenshot18_HWW_Confirm-Locktime.png b/...ugh/Screenshot18_HWW_Confirm-Locktime.png → ...ugh/Screenshot18_HWW_Confirm-Locktime.png
diff --git a/.../Screenshot19_HWW_Confirm-Amount-Fees.png → .../Screenshot19_HWW_Confirm-Amount-Fees.png b/.../Screenshot19_HWW_Confirm-Amount-Fees.png → .../Screenshot19_HWW_Confirm-Amount-Fees.png
diff --git a/...reenshot20_Core_Console_getblockcount.png → ...reenshot20_Core_Console_getblockcount.png b/...reenshot20_Core_Console_getblockcount.png → ...reenshot20_Core_Console_getblockcount.png
diff --git a/...ugh/Screenshot21_HWI_Show-Signed-PSBT.png → ...ugh/Screenshot21_HWI_Show-Signed-PSBT.png b/...ugh/Screenshot21_HWI_Show-Signed-PSBT.png → ...ugh/Screenshot21_HWI_Show-Signed-PSBT.png
diff --git a/...reenshot22_Core_Broadcast-Signed-PSBT.png → ...reenshot22_Core_Broadcast-Signed-PSBT.png b/...reenshot22_Core_Broadcast-Signed-PSBT.png → ...reenshot22_Core_Broadcast-Signed-PSBT.png
diff --git a/...gh/Screenshot23_Core_Transactions-Tab.png → ...gh/Screenshot23_Core_Transactions-Tab.png b/...gh/Screenshot23_Core_Transactions-Tab.png → ...gh/Screenshot23_Core_Transactions-Tab.png
diff --git a/...Screenshot24_Core_Transaction-Details.png → ...Screenshot24_Core_Transaction-Details.png b/...Screenshot24_Core_Transaction-Details.png → ...Screenshot24_Core_Transaction-Details.png
diff --git a/...eenshot25_Core_Console-gettransaction.png → ...eenshot25_Core_Console-gettransaction.png b/...eenshot25_Core_Console-gettransaction.png → ...eenshot25_Core_Console-gettransaction.png
diff --git a/docs/walk-through/README.rst → docs/examples/walkthrough/walkthrough.rst b/docs/walk-through/README.rst → docs/examples/walkthrough/walkthrough.rst
@@ -1,8 +1,5 @@
-How to Use a Hardware Wallet with Bitcoin Core Wallet
-*****************************************************
-
-A Step-by-step Walk-Through
-***************************
+Walkthrough: Using a Hardware Wallet with Bitcoin Core Wallet
+******************************************************************
 
 Summary: On this page we describe step-by-step and show in screenshots how to use a hardware wallet and HWI 
 together with a Bitcoin Core Wallet. As hardware wallet example we have used a Trezor.