[#2442] enable nitpicky in sphinx

To warn about all broken references. Also fixes the few broken
references found.

diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst
index 0b541df31e09debd312eda4b8ce469cdcb56d55a..05e19d99ac9b5d423187de0080cbc666290f2f5f 100644 (file)
--- a/doc/sphinx/arm/config-backend.rst
+++ b/doc/sphinx/arm/config-backend.rst
@@ -241,8 +241,7 @@ servers.
 To differentiate between different Kea server configurations, a
 list of the server tags used by the servers must be stored in the
 database. For the DHCPv4 and DHCPv6 servers, it can be done using the
-:isccmd:`command-remote-server4-set` and
-:isccmd:`command-remote-server6-set` commands. The
+:isccmd:`remote-server4-set` and :isccmd:`remote-server6-set` commands. The
 server tags can then be used to associate the configuration information with
 the servers. However, it is important to note that some DHCP
 configuration elements may be associated with multiple server tags (known

diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst
index 9f79d9b84b7a5c21104b30ab4acf003ae094d5f5..237f9116d177100388259572bb03753e0d4dff80 100644 (file)
--- a/doc/sphinx/arm/hooks-cb-cmds.rst
+++ b/doc/sphinx/arm/hooks-cb-cmds.rst
@@ -47,7 +47,7 @@ There are 5 types of commands supported by this library:
    :isccmd:`remote-global-parameter4-del`.
 
 -  ``get`` - fetch the selected object from the database, e.g.
-   :isccmd:`remote-subnet4-get`.
+   :isccmd:`remote-subnet4-get-by-id`.
 
 -  ``get-all`` - fetch all objects of the particular type from the
    database, e.g. :isccmd:`remote-option-def4-get-all`.

diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst
index 56e99d04bcb8a3e31cbfaa93bd76da6b7a067c1a..52b091da68879b094cde8c26328a7cb904202812 100644 (file)
--- a/doc/sphinx/arm/logging.rst
+++ b/doc/sphinx/arm/logging.rst
@@ -263,8 +263,7 @@ libraries), or hook libraries (open source or premium).
    | ``kea-dhcp6.dhcp6``              |                                       |                                |
    +----------------------------------+---------------------------------------+--------------------------------+
    | ``kea-dhcp4.dhcpsrv``,           | core                                  | The base loggers for the       |
-   | ``kea-dhcp6.dhcpsrv``            |                                       | :ischooklib:`libkea-dhcpsrv`   |
-   |                                  |                                       | library.                       |
+   | ``kea-dhcp6.dhcpsrv``            |                                       | ``libkea-dhcpsrv.so`` library. |
    +----------------------------------+---------------------------------------+--------------------------------+
    | ``kea-dhcp4.eval``,              | core                                  | Used to log messages           |
    | ``kea-dhcp6.eval``               |                                       | relating to the                |
@@ -908,8 +907,8 @@ A complete list of logging parameters supported by Kea is shown in the table bel
    | ``%%``    | Outputs a literal percent sign                                         |
    +-----------+------------------------------------------------------------------------+
 
-Padding and truncation are also possible with modifiers preceeding the component.  This is 
-done by placing a number and other modifier characters between the component and the % 
+Padding and truncation are also possible with modifiers preceeding the component.  This is
+done by placing a number and other modifier characters between the component and the %
 sign. There are five ways of modifying the output shown by example here.
 
   - ``%20p``
@@ -934,7 +933,7 @@ sign. There are five ways of modifying the output shown by example here.
 
 Supported parameters depend on the liblog4cplus version used to compile Kea.  This can
 be checked by executing ``kea-dhcp4 -W | grep -i log4cplus`` which will produce output
-like this: ``LOG4CPLUS_VERSION:  2.0.5``.  Consult the documentation in the 
+like this: ``LOG4CPLUS_VERSION:  2.0.5``.  Consult the documentation in the
 `log4cplus wiki <https://github.com/log4cplus/log4cplus/wiki>`__ for further information
 about the version you have installed.
 

diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index ed5025217c83b90d61f7dfa50bb90de402df3fd3..3fe30f5de58e4609e962c8e0cea30d7dca3f00eb 100644 (file)
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -125,6 +125,9 @@ exclude_patterns = [
     'arm/hooks-user-chk.rst',
 ]
 
+# Report broken references.
+nitpicky = True
+
 # Leave quotes and dashes unchanged and don't convert them to typographically
 # correct entities.
 smartquotes = False