Merge branch 'update-09-2020' into 'master'

Get rid of build warnings. See merge request zcash-docs/zcash-docs!201
Electric-Coin-Company · Sep 3, 2020 · 416a435 · 416a435
2 parents e73f0ae + 19db352
commit 416a435
Show file tree

Hide file tree

Showing 18 changed files with 50 additions and 30 deletions.
diff --git a/source/index.rst b/source/index.rst
@@ -138,3 +138,13 @@ This is the home for Zcash documentation for end users and developers. Check out
    rtd_pages/funding.md
    rtd_pages/learning.md
    rtd_pages/dev_tools.md
+
+.. (pages not included)
+  :hidden:
+   rtd_pages/lightwalletd.md
+   rtd_pages/Debian-Ubuntu-build.md
+   rtd_pages/OSx-build.md
+   rtd_pages/Linux-misc-build.md
+   rtd_pages/windows-build.md
+   rtd_pages/wallet_threat_model.md
+   rtd_pages/memos.md
diff --git a/source/rtd_pages/Debian-Ubuntu-build.md b/source/rtd_pages/Debian-Ubuntu-build.md
@@ -1,12 +1,12 @@
 # Building Zcashd & Zcash-cli on Debian/Ubuntu
 
-Zcashd & Zcash-cli are [officially supported](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy) for Debian/Ubuntu. Since Debian/Ubuntu is the best supported platform, we recommend running Zcashd & Zcash-cli on Debian/Ubuntu if possible. 
+Zcashd & Zcash-cli are [officially supported](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html) for Debian/Ubuntu. Since Debian/Ubuntu is the best supported platform, we recommend running Zcashd & Zcash-cli on Debian/Ubuntu if possible. 
 
 ## Instructions
 
 There are multiple ways to download dependencies and build Zcashd & Zcash-cli. We've listed the various ways, in order of recommendation (try the packages first!). 
 
-* [Debian Packages Setup](install_debian_bin_packages.html); below video follows these instructions. 
+* [Debian Packages Setup](https://zcash.readthedocs.io/en/latest/rtd_pages/install_debian_bin_packages.html); below video follows these instructions. 
 
   <iframe width="560" height="315" src="https://www.youtube.com/embed/hTKL0jPu7X0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
@@ -40,9 +40,9 @@ There are multiple ways to download dependencies and build Zcashd & Zcash-cli. W
     (If you don't have ``nproc``, then substitute the number of cores on your system. If the build runs out of memory, try again without the ``-j`` argument, i.e. just ``./zcutil/build.sh``.)
 
 
-* [Binary Tarball Download and Setup](install_binary_tarball.html) 
+* [Binary Tarball Download and Setup](https://zcash.readthedocs.io/en/latest/rtd_pages/install_binary_tarball.html) 
 
 	The .tar file unzips into a directory and does not involve a package manager, so it is agnostic of whether that system uses an OS package manager or which one it uses.
 
 ## Next steps
-Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions. 
+Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions. 
diff --git a/source/rtd_pages/Linux-misc-build.md b/source/rtd_pages/Linux-misc-build.md
@@ -55,4 +55,4 @@ Currently, the only way to install Zcashd & Zcash-cli on Linux is to build from
     If you don't have ``nproc``, then substitute the number of cores on your system. If the build runs out of memory, try again without the ``-j`` argument, i.e. just ``./zcutil/build.sh``
 
 ## Next steps
-Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions. 
+Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions. 
diff --git a/source/rtd_pages/OSx-build.md b/source/rtd_pages/OSx-build.md
@@ -52,4 +52,4 @@ Currently, the only way to install Zcashd & Zcash-cli on OSx is to build from so
 
 
 ## Next steps
-Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](zcashd.html) for further instructions. 
+Now that you've built Zcashd & Zcash-cli, we can move on to the next steps of: configuration, sync, and use. Refer back to the [Zcashd & Zcash-cli page](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html) for further instructions. 
diff --git a/source/rtd_pages/best_practices.md b/source/rtd_pages/best_practices.md
@@ -1,10 +1,10 @@
 # Development Best Practices
 
-We pledge to respect all contributors. In the interest of fostering an open and welcoming community, we also expect contributors to adhere to the [contributor code of conduct](code_of_conduct.html).
+We pledge to respect all contributors. In the interest of fostering an open and welcoming community, we also expect contributors to adhere to the [contributor code of conduct](https://zcash.readthedocs.io/en/latest/rtd_pages/code_of_conduct.html).
 
 ## Development workflow
 
-The [Development workflow and guidelines](development_guidelines.html) will get you up to speed and contribute to Zcash projects. It talks about the Zcash Github workflow, which has a few quirks from the general git flow, how Zcash core developers code and test, and the nuts and bolts of operation (CI, versioning, and release process). 
+The [Development workflow and guidelines](https://zcash.readthedocs.io/en/latest/rtd_pages/development_guidelines.html) will get you up to speed and contribute to Zcash projects. It talks about the Zcash Github workflow, which has a few quirks from the general git flow, how Zcash core developers code and test, and the nuts and bolts of operation (CI, versioning, and release process). 
 
 ## Handling Zcash features
-The [Zcash feature UX checklist](ux_wallet_checklist.html) will give you an idea of how Zcash features are standardly treated, and how you should design for them. For instance, shielded addresses should be used long term, since using a new one per transaction (industry standard) does not provide additional privacy. These lessons learned over time will save you some technical complexity and support calls if you follow these guidelines. 
+The [Zcash feature UX checklist](https://zcash.readthedocs.io/en/latest/rtd_pages/ux_wallet_checklist.html) will give you an idea of how Zcash features are standardly treated, and how you should design for them. For instance, shielded addresses should be used long term, since using a new one per transaction (industry standard) does not provide additional privacy. These lessons learned over time will save you some technical complexity and support calls if you follow these guidelines. 
diff --git a/source/rtd_pages/dev_tools.md b/source/rtd_pages/dev_tools.md
@@ -8,17 +8,17 @@ Thee [Zcash RPC webpage](https://zcash-rpc.github.io/) makes it easy to look at
 
 ## Public Test Network
 
-The [Zcash testnet](testnet_guide.html) is a blockchain that attempts to mimic the main Zcash network for testing purposes, with its own coins that hold no monetary value (TAZ). It's used by developers to experiment with Zcash apps having to use Zcash (ZEC) and test network upgrades before activating on the main Zcash network. Since it's public and long-running, you can see a lot of historical data, and interact with many peers. 
+The [Zcash testnet](https://zcash.readthedocs.io/en/latest/rtd_pages/testnet_guide.html) is a blockchain that attempts to mimic the main Zcash network for testing purposes, with its own coins that hold no monetary value (TAZ). It's used by developers to experiment with Zcash apps having to use Zcash (ZEC) and test network upgrades before activating on the main Zcash network. Since it's public and long-running, you can see a lot of historical data, and interact with many peers. 
 
 ## Private Containerized Network
 
-The [Zcash testnet-in-a-box (TNB)](https://github.com/zcash-hackworks/zcash-testnet-in-a-box) will deploy a collection of monitored and peered zcashd instances to a Kubernetes cluster. This is useful for isolated testing in a controlled environent, giving you the control of how many node are on the network, how many transactions are sent and mined, etc. New protocol development, or research on new RPCs will benefit greatly from this tool. 
+The [Zcash testnet-in-a-box (TNB)](https://github.com/zcash-hackworks/zcash-testnet-in-a-box) will deploy a collection of monitored and peered zcashd instances to a Kubernetes cluster. This is useful for isolated testing in a controlled environent. This gives the ability to control of how many nodes are on the network, how many transactions are sent and mined, and more. New protocol development or research on new RPCs will benefit greatly from this tool. 
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/1360lSmfhnw" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ## Block Explorer
 
-By default, zcashd will operate as a full node and wallet. However, zcashd can alternatively be run as a [full node with access to a block explorer](insight_explorer.html), which allows it to see and fetch additonal fields (i.e. utxos, spent txid). This zcashd mode is commonly used along with zcash-cli to service exchanges, wallets, and other zcash services, but cannot be used as a wallet itself since it will contain no private keys.
+By default, zcashd will operate as a full node and wallet. However, zcashd can alternatively be run as a [full node with access to a block explorer](https://zcash.readthedocs.io/en/latest/rtd_pages/insight_explorer.html), which allows it to see and fetch additonal fields (i.e. utxos, spent txid). This zcashd mode is commonly used along with zcash-cli to service exchanges, wallets, and other zcash services, but cannot be used as a wallet itself since it will contain no private keys.
 
 <!--## todo-->
 <!--grafana dashboard-->

diff --git a/source/rtd_pages/dnsseed_policy.rst b/source/rtd_pages/dnsseed_policy.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _dnsseed_policy:
 
 Expectations for DNS Seed operators

diff --git a/source/rtd_pages/files.rst b/source/rtd_pages/files.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _files:
 
 Data Directory Files

diff --git a/source/rtd_pages/glossary.rst b/source/rtd_pages/glossary.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _glossary:
 
 Glossary

diff --git a/source/rtd_pages/index_zips.rst b/source/rtd_pages/index_zips.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Zcash Improvement Proposals (ZIPs)
 ==================================
 

diff --git a/source/rtd_pages/nu_dev_guide.rst b/source/rtd_pages/nu_dev_guide.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _nu_dev_guide:
 
 Network Upgrade Developer Guide

diff --git a/source/rtd_pages/payment_api.rst b/source/rtd_pages/payment_api.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _payment_api:
 
 Zcash Payment API

diff --git a/source/rtd_pages/protocol.md b/source/rtd_pages/protocol.md
@@ -14,4 +14,4 @@ The most up-to-date [Zcash Protocol Specification](https://zips.z.cash/protocol/
 
 ## Network Upgrade Guide
 
-The [Network Upgrade Guide](nu_dev_guide.html) gives advice on how to stay current with the Zcash protocol and network. It also details the changes made with each network upgrade, and if and how those changes necessitate changes on supporting services. Network upgrades on a bi-annual basis to maintain the Zcash network.
+The [Network Upgrade Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/nu_dev_guide.html) gives advice on how to stay current with the Zcash protocol and network. It also details the changes made with each network upgrade, and if and how those changes necessitate changes on supporting services. Network upgrades on a bi-annual basis to maintain the Zcash network.
diff --git a/source/rtd_pages/troubleshooting_guide.rst b/source/rtd_pages/troubleshooting_guide.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _troubleshooting-guide:
 
 Troubleshooting Guide

diff --git a/source/rtd_pages/user_guide.rst b/source/rtd_pages/user_guide.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _user_guide:
 
 User Guide

diff --git a/source/rtd_pages/ux_wallet_checklist.rst b/source/rtd_pages/ux_wallet_checklist.rst
@@ -1,3 +1,4 @@
+:orphan:
 .. _ux_wallet_checklist:
 
 Zcash Feature UX Checklist

diff --git a/source/rtd_pages/zcashd.md b/source/rtd_pages/zcashd.md
@@ -11,13 +11,13 @@ Zcashd & Zcash-cli are maintained by Electric Coin Company (the founding team fo
 
 * [Docker](https://hub.docker.com/r/electriccoinco/zcashd)(containerized DebianOS)
 
-* [Debian/Ubuntu](Debian-Ubuntu-build.md) ([officially](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy) supported)
+* [Debian/Ubuntu](https://zcash.readthedocs.io/en/latest/rtd_pages/Debian-Ubuntu-build.md) ([officially](https://zcash.readthedocs.io/en/latest/rtd_pages/supported_platform_policy.html#supported-platform-policy) supported)
 
-* [Other Linux Systems](Linux-misc-build.md) ("best-effort" supported)
+* [Other Linux Systems](https://zcash.readthedocs.io/en/latest/rtd_pages/Linux-misc-build.md) ("best-effort" supported)
 
-* [OSx](OSx-build.md) ("best-effort" supported)
+* [OSx](https://zcash.readthedocs.io/en/latest/rtd_pages/OSx-build.md) ("best-effort" supported)
 
-* [Windows](windows-build.md) (unsupported)
+* [Windows](https://zcash.readthedocs.io/en/latest/rtd_pages/windows-build.md) (unsupported)
 
 
 ## Configuration
@@ -31,7 +31,7 @@ mkdir -p ~/.zcash
 touch ~./zcash/zcash.conf
 ```
 
-Zcashd can be configured in various ways to suit different use cases; see the [Zcash.conf guide](zcash_conf_guide.html) for an extensive list of options. 
+Zcashd can be configured in various ways to suit different use cases; see the [Zcash.conf guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_conf_guide.html) for an extensive list of options. 
 
 ## Sync
 
@@ -64,18 +64,18 @@ Helpful tips:
    ./zcutil/build.sh -j$(nproc)
   ```
 * Running ``make clean`` before building the update can eliminate random known link errors. 
-* If you run into issues upgrading, please see the [Network Upgrade Guide](nu_dev_guide.html).
+* If you run into issues upgrading, please see the [Network Upgrade Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/nu_dev_guide.html).
 
 ## References
 
 An extensive list of Zcashd & Zcash-cli pages, including ones linked inline in this page above. 
-* [User Guide](user_guide.html)
-* [Troubleshooting Guide](troubleshooting_guide.html)
-* [Zcash Payment API](payment_api.html)
-* [Wallet Backup Instructions](wallet_backup.html)
-* [Sending Memos with Zcashd](memos.html)
-* [Zcash.conf guide](zcash_conf_guide.html)
-* [Zcash Mining guide](zcash_mining_guide.html)
-* [Security Warnings](security_warnings.html)
-* [Data Directory Files](files.html)
-* [Tor Support in zcashd](tor.html)
+* [User Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/user_guide.html)
+* [Troubleshooting Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/troubleshooting_guide.html)
+* [Zcash Payment API](https://zcash.readthedocs.io/en/latest/rtd_pages/payment_api.html)
+* [Wallet Backup Instructions](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_backup.html)
+* [Sending Memos with Zcashd](https://zcash.readthedocs.io/en/latest/rtd_pages/memos.html)
+* [Zcash.conf guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_conf_guide.html)
+* [Zcash Mining guide](https://zcash.readthedocs.io/en/latest/rtd_pages/zcash_mining_guide.html)
+* [Security Warnings](https://zcash.readthedocs.io/en/latest/rtd_pages/security_warnings.html)
+* [Data Directory Files](https://zcash.readthedocs.io/en/latest/rtd_pages/files.html)
+* [Tor Support in zcashd](https://zcash.readthedocs.io/en/latest/rtd_pages/tor.html)
diff --git a/source/rtd_pages/zig.rst b/source/rtd_pages/zig.rst
@@ -64,7 +64,7 @@ Contact Us
 For assistance with integrating Zcash into your product, send us a message at ecosystem@z.cash.
 
 References
----------
+----------
 
 :fa:`arrow-circle-right` :ref:`user_guide`