From 400a5e3661bcd136793cd8b67a9b9f3a93a3597e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 4 May 2021 19:20:17 +0200 Subject: [PATCH] doc: fix several Sphinx warnings --- docs/008/voting.rst | 3 +++ docs/009/voting.rst | 2 ++ docs/README.rst | 2 +- docs/alpha/voting.rst | 2 ++ docs/developer/profiling.rst | 4 ++-- docs/introduction/howtouse.rst | 2 +- docs/protocols/alpha.rst | 10 +++++----- docs/user/multisig.rst | 2 +- 8 files changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/008/voting.rst b/docs/008/voting.rst index 86a2f5cc1cd5..4ea62f48a4d6 100644 --- a/docs/008/voting.rst +++ b/docs/008/voting.rst @@ -1,3 +1,6 @@ +.. _voting: +.. _voting_008: + The Voting Process ================== diff --git a/docs/009/voting.rst b/docs/009/voting.rst index a66f180b3729..52966ab7110e 100644 --- a/docs/009/voting.rst +++ b/docs/009/voting.rst @@ -1,3 +1,5 @@ +.. _voting_009: + The Voting Process ================== diff --git a/docs/README.rst b/docs/README.rst index 9a7b5fad2635..fde410deca89 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -98,7 +98,7 @@ However, when adding a new page or modifying an existing one, you should check t For that, you should build the documentation (by running ``make`` in the ``docs`` directory), address any new error message, and check the generated pages (`docs/_build/index.html`) in a browser. Links -~~~~ +~~~~~ +When introducing cross-references between documentation pages as well as references to external resources, please consider using the most appropriate kind of link: diff --git a/docs/alpha/voting.rst b/docs/alpha/voting.rst index ce14b4cde181..84ce3bb325e3 100644 --- a/docs/alpha/voting.rst +++ b/docs/alpha/voting.rst @@ -1,3 +1,5 @@ +.. _voting_alpha: + The Voting Process ================== diff --git a/docs/developer/profiling.rst b/docs/developer/profiling.rst index 612b9e67bcd5..612377f2de12 100644 --- a/docs/developer/profiling.rst +++ b/docs/developer/profiling.rst @@ -91,8 +91,8 @@ Performance profiling - `flamegraph `_: command-line tool for generating flamegraphs - (`example `_ for tezos-node) + (`example `__ for tezos-node) - `gprof2dot `_: command-line tool for generating callgraphs - (`example `_ for tezos-node) + (`example `__ for tezos-node) - `hotspot `_: a GUI for the `perf` tool diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 3a92b668566e..d85a4377b290 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -160,7 +160,7 @@ means that your node will take some time to resync the chain. If removing this directory, please note that if it took you a long time to compute your node identity, keep the ``identity.json`` file and instead only -remove its child ``store``, ``context`` and ``protocol``(if any) sub-directories. +remove its child ``store``, ``context`` and ``protocol`` (if any) sub-directories. If you are also running a baker, make sure that it is configured to access the data directory of the node (see :ref:`how to run a baker `). diff --git a/docs/protocols/alpha.rst b/docs/protocols/alpha.rst index abe98092013a..bec15095bbee 100644 --- a/docs/protocols/alpha.rst +++ b/docs/protocols/alpha.rst @@ -49,7 +49,7 @@ The values of the ``BLOCKS_PER_*`` constants has doubled in order to match the reduced block times, as follows: ``BLOCKS_PER_CYCLE = 8192``, ``BLOCKS_PER_COMMITMENT = 64``, ``BLOCKS_PER_ROLL_SNAPSHOT = 512``, and ``BLOCKS_PER_VOTING_PERIOD = 40960``. This partially solves issue: `tezos#1027 `__ - `tezos!2531 `__ +via MR `tezos!2531 `__ . Liquidity Baking ---------------- @@ -72,16 +72,16 @@ RPC changes - Remove deprecated RPCs and deprecated fields in RPC answers related to voting periods. (MR `tezos!2763 `__, addresses - issue `tezos#1204 __.) + issue `tezos#1204 `__.) - The RPC ``..//required_endorsements`` has been removed. - Replace `deposit` by `deposits` in `frozen_balance` RPC. - All the protocol-specific RPCs under the ``helpers`` path have been -moved from the protocol to the `recently introduced `_ RPC -plugin. This change should not be visible for end-users but improves -the maintainability of these RPCs. + moved from the protocol to the `recently introduced `_ RPC + plugin. This change should not be visible for end-users but improves + the maintainability of these RPCs. Minor changes ------------- diff --git a/docs/user/multisig.rst b/docs/user/multisig.rst index a0a2f95c52b2..8d30fe196d1c 100644 --- a/docs/user/multisig.rst +++ b/docs/user/multisig.rst @@ -17,7 +17,7 @@ multisig contract has built-in support in the ``tezos-client`` and has been formally verified using the `Mi-Cho-Coq `_ framework. Interacting with a multisig contract using ``tezos-client`` -------------------------------------------------------- +----------------------------------------------------------- The recommended way to create and use a multisig contract is via the ``tezos-client`` built-in commands for the multisig contract. The command -- GitLab