Fail docs build when warnings are raised. Fix warnings.

pull/1352/head
David Núñez 2019-09-22 23:39:41 +02:00
parent 5778026cec
commit eb4f01d39b
6 changed files with 23 additions and 9 deletions

View File

@ -2,7 +2,7 @@
# #
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS = -W
SPHINXBUILD = python3 -m sphinx SPHINXBUILD = python3 -m sphinx
SOURCEDIR = source SOURCEDIR = source
BUILDDIR = build BUILDDIR = build

View File

@ -1,5 +1,5 @@
Policy Policy
====== ======
.. automodule:: nucypher.policy.models .. automodule:: nucypher.policy.policies
:members: :members:

View File

@ -14,6 +14,9 @@
## Deployment Procedure ## Deployment Procedure
This section describes how NuCypher contracts are deployed, step-by-step.
For a guide of how to deploy these contracts automatically, see the [Deployment guide](/guides/deployment_guide).
1. Deploy `NuCypherToken` with all future supply tokens 1. Deploy `NuCypherToken` with all future supply tokens
2. Deploy `StakingEscrow` with a dispatcher targeting it 2. Deploy `StakingEscrow` with a dispatcher targeting it
3. Deploy `PolicyManager` with its own dispatcher, also targeting it 3. Deploy `PolicyManager` with its own dispatcher, also targeting it

View File

@ -1,3 +1,8 @@
..
TODO: #1354 - Find a home for this guide
:orphan:
================= =================
Deployment Guide Deployment Guide
================= =================

View File

@ -1,3 +1,8 @@
..
TODO: #1354 - Find a home for this guide
:orphan:
============================================= =============================================
NuCypher Federated Testnet (NuFT) Setup Guide NuCypher Federated Testnet (NuFT) Setup Guide
============================================= =============================================

View File

@ -43,7 +43,7 @@ All staking-related operations done by StakeHolder are performed through the ``n
+----------------------+-------------------------------------------------------------------------------+ +----------------------+-------------------------------------------------------------------------------+
| ``divide`` | Create a new stake from part of an existing one | | ``divide`` | Create a new stake from part of an existing one |
+----------------------+-------------------------------------------------------------------------------+ +----------------------+-------------------------------------------------------------------------------+
| ``restake`` | Manage automatic reward re-staking | | ``restake`` | Manage automatic reward re-staking |
+----------------------+-------------------------------------------------------------------------------+ +----------------------+-------------------------------------------------------------------------------+
**Stake Command Options** **Stake Command Options**
@ -60,7 +60,7 @@ All staking-related operations done by StakeHolder are performed through the ``n
| ``--hw-wallet`` | Use a hardware wallet | | ``--hw-wallet`` | Use a hardware wallet |
+-----------------+--------------------------------------------+ +-----------------+--------------------------------------------+
**ReStake Command Options** **Re-stake Command Options**
+-------------------------+---------------------------------------------+ +-------------------------+---------------------------------------------+
| Option | Description | | Option | Description |
@ -79,7 +79,7 @@ Staking Overview
Most stakers on the Goerli testnet will complete the following steps: Most stakers on the Goerli testnet will complete the following steps:
1) Install ``nucypher`` on StakeHolder node https://docs.nucypher.com/en/latest/guides/installation_guide.html 1) Install ``nucypher`` on StakeHolder node (See :doc:`/guides/installation_guide`)
2) Install and run Geth, Parity or another ethereum node (can be used with software or hardware Ethereum wallet). 2) Install and run Geth, Parity or another ethereum node (can be used with software or hardware Ethereum wallet).
3) Request testnet tokens from faucet 3) Request testnet tokens from faucet
4) Stake tokens (See Below) 4) Stake tokens (See Below)
@ -242,6 +242,7 @@ in the address. However, geth shows addresses in the lower case. You can convert
the address to checksum format in geth console: the address to checksum format in geth console:
.. code:: bash .. code:: bash
$ geth attach ~/.ethereum/goerli/geth.ipc $ geth attach ~/.ethereum/goerli/geth.ipc
> eth.accounts > eth.accounts
["0x287a817426dd1ae78ea23e9918e2273b6733a43d", "0xc080708026a3a280894365efd51bb64521c45147"] ["0x287a817426dd1ae78ea23e9918e2273b6733a43d", "0xc080708026a3a280894365efd51bb64521c45147"]
@ -262,22 +263,22 @@ to enable it run:
(nucypher)$ nucypher stake restake --enable (nucypher)$ nucypher stake restake --enable
To disable restaking: To disable re-staking:
.. code:: bash .. code:: bash
(nucypher)$ nucypher stake restake --disable (nucypher)$ nucypher stake restake --disable
Additionally, you can enable **restake locking**, an on-chain commitment to continue restaking Additionally, you can enable **re-stake locking**, an on-chain commitment to continue re-staking
until a future period (`release_period`). Once enabled, the `StakingEscrow` contract will not until a future period (`release_period`). Once enabled, the `StakingEscrow` contract will not
allow **restaking** to be disabled until the release period begins, even if you are the stake owner. allow **re-staking** to be disabled until the release period begins, even if you are the stake owner.
.. code:: bash .. code:: bash
(nucypher)$ nucypher stake restake --lock-until 12345 (nucypher)$ nucypher stake restake --lock-until 12345
No action is needed to release the restaking lock once the release period begins. No action is needed to release the re-staking lock once the release period begins.
Collect rewards earned by the staker Collect rewards earned by the staker