[Docs] Clean up dead links

second-state · Nov 26, 2018 · 61822c7 · 61822c7
1 parent 9e17ac3
commit 61822c7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 38 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -71,6 +71,9 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# Warn about all references where the target cannot be found
+nitpicky = True
+
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/erc-contract-checker-guide.rst b/docs/erc-contract-checker-guide.rst
@@ -1,21 +1,19 @@
 ERC contract checker guide
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Please make sure that lityc has been installed on your system. If not, please follow :doc:`Getting started <getting-started>`.
+
 .. _erc-contract-checker-guide:
 
 ERC20 Contract Standard Checker
 ===============================
 
-Make sure you are in the folder where lityc is installed.
-
-For example your location should be "~/lity/build" if you followed `this tutorial <http://lity.readthedocs.io/en/latest/download.html>`_.
-
 Enable contract standard checker with specific ERC
 --------------------------------------------------
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC20 <contract file>
+  $ lityc --contract-standard ERC20 <contract file>
 
 
 Examples
@@ -44,7 +42,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC20 erc20_interface.sol
+  $ lityc --contract-standard ERC20 erc20_interface.sol
 
   erc20_standard.sol:3:1: Info: ERC20Interface is compatible to ERC20.
   contract ERC20Interface {
@@ -75,7 +73,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC20 wrong_mutability.sol
+  $ lityc --contract-standard ERC20 wrong_mutability.sol
 
   wrong_mutability.sol:3:1: Info: Missing 'totalSupply' with type signature 'function () view external returns (uint256)'. ERC20Interface is not compatible to ERC20.
   contract ERC20Interface {
@@ -85,16 +83,12 @@ Examples
 ERC223 Contract Standard Checker
 ================================
 
-Make sure you are in the folder where lityc is installed.
-
-For example your location should be "~/lity/build" if you followed `this tutorial <http://lity.readthedocs.io/en/latest/download.html>`_.
-
 Enable contract standard checker with specific ERC
 --------------------------------------------------
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC223 <contract file>
+  $ lityc --contract-standard ERC223 <contract file>
 
 
 Examples
@@ -119,7 +113,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC223 erc223_interface.sol
+  $ lityc --contract-standard ERC223 erc223_interface.sol
 
   erc223_standard.sol:3:1: Info: ERC223Interface is compatible to ERC223.
   contract ERC223Interface {
@@ -253,7 +247,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC223 erc223_token.sol
+  $ lityc --contract-standard ERC223 erc223_token.sol
 
   erc223_token.sol:6:1: Info: Missing 'totalSupply' with type signature 'function () view external returns (uint256)'. SafeMath is not compatible to ERC223.
   library SafeMath {
@@ -272,16 +266,12 @@ Examples
 ERC721 Contract Standard Checker
 ================================
 
-Make sure you are in the folder where lityc is installed.
-
-For example your location should be "~/lity/build" if you followed `this tutorial <http://lity.readthedocs.io/en/latest/download.html>`_.
-
 Enable contract standard checker with specific ERC
 --------------------------------------------------
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC721 <contract file>
+  $ lityc --contract-standard ERC721 <contract file>
 
 
 Examples
@@ -314,7 +304,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC721 erc721_interface.sol
+  $ lityc --contract-standard ERC721 erc721_interface.sol
   erc721_interface.sol:3:1: Info: ERC721Interface is compatible to ERC721.
   contract ERC721Interface {
   ^ (Relevant source part starts here and spans across multiple lines).
@@ -349,7 +339,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC721 wrong_modification_level.sol
+  $ lityc --contract-standard ERC721 wrong_modification_level.sol
 
   wrong_modification_level.sol:3:1: Info: Missing 'transferFrom' with type signature 'function (address,address,uint256) payable external'. ERC721Interface is not compatible to ERC721.
   contract ERC721Interface {
@@ -359,16 +349,12 @@ Examples
 ERC827 Contract Standard Checker
 ================================
 
-Make sure you are in the folder where lityc is installed.
-
-For example your location should be "~/lity/build" if you followed `this tutorial <http://lity.readthedocs.io/en/latest/download.html>`_.
-
 Enable contract standard checker with specific ERC
 --------------------------------------------------
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC827 <contract file>
+  $ lityc --contract-standard ERC827 <contract file>
 
 
 Examples
@@ -399,7 +385,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC827 erc827_standard_no_inheritance.sol
+  $ lityc --contract-standard ERC827 erc827_standard_no_inheritance.sol
 
   erc827_standard_no_inheritance.sol:3:1: Info: ERC827Interface is compatible to ERC827.
   contract ERC827Interface {
@@ -432,7 +418,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC827 erc827_standard.sol
+  $ lityc --contract-standard ERC827 erc827_standard.sol
 
   erc827_standard.sol:3:1: Info: Missing 'transferAndCall' with type signature 'function (address,uint256,bytes memory) payable external returns (bool)'. ERC827Base is not compatible to ERC827.
   contract ERC827Base {
@@ -445,16 +431,12 @@ Examples
 ERC884 Contract Standard Checker
 ================================
 
-Make sure you are in the folder where lityc is installed.
-
-For example your location should be "~/lity/build" if you followed `this tutorial <http://lity.readthedocs.io/en/latest/download.html>`_.
-
 Enable contract standard checker with specific ERC
 --------------------------------------------------
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC884 <contract file>
+  $ lityc --contract-standard ERC884 <contract file>
 
 
 Examples
@@ -501,7 +483,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC884 erc884_standard.sol
+  $ lityc --contract-standard ERC884 erc884_standard.sol
 
   erc884_standard.sol:3:1: Info: Missing 'VerifiedAddressAdded' with type signature 'function (address,bytes32,address)'. C20 is not compatible to ERC884.
   contract C20 {
@@ -539,7 +521,7 @@ Examples
 
 .. code:: bash
 
-  $ ./lityc/lityc --contract-standard ERC884 missing_function.sol
+  $ lityc --contract-standard ERC884 missing_function.sol
 
   missing_function.sol:3:1: Info: Missing 'VerifiedAddressAdded' with type signature 'function (address,bytes32,address)'. ERC884Interface is not compatible to ERC884.
   contract ERC884Interface {

diff --git a/docs/features-overview.rst b/docs/features-overview.rst
@@ -7,7 +7,7 @@ Better Security
 ERC Checker
 ```````````
 
-Lity can check if your contract's interface is compatible to specific ERC standards, please refer to `ERC contract checker guide <erc-contract-checker-guide>`_
+Lity can check if your contract's interface is compatible to specific ERC standards, please refer to :doc:`ERC contract checker guide <erc-contract-checker-guide>`
 
 
 Overflow Protection
@@ -56,5 +56,5 @@ See Lity rule language for reference. Lity's rule grammar is very similar with D
 This feature is compatible with official Ethereum Virtual Machine.
 Because, Lity directly compiles rule language into official EVM byte code.
 
-Check :ref:`the rule engine guide <rule-engine-guide>` for how to use Lity's rule engine.
+Check :doc:`the rule engine guide <rule-engine-guide>` for how to use Lity's rule engine.