From: Tomek Mrugalski <tomasz@isc.org>
Date: Wed, 7 Aug 2019 14:54:47 +0000 (+0200)
Subject: [#809,!469] Sphinx generation fix.
X-Git-Tag: Kea-1.6.0~41^2~147
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97a99db76af0c698e554d31cbf9b4c8a09ecbcd5;p=thirdparty%2Fkea.git

[#809,!469] Sphinx generation fix.
---

diff --git a/doc/sphinx/api/config-set.json b/doc/sphinx/api/config-set.json
index d0a6106516..02fc74a7cf 100644
--- a/doc/sphinx/api/config-set.json
+++ b/doc/sphinx/api/config-set.json
@@ -4,7 +4,7 @@
         "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
     ],
     "cmd-comment": [
-        "where &lt;server&gt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+        "where `<server>` is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
     ],
     "cmd-syntax": [
         "{",
@@ -30,4 +30,4 @@
         "kea-dhcp-ddns",
         "kea-ctrl-agent"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/config-test.json b/doc/sphinx/api/config-test.json
index 6399ca2bfd..335d06e9db 100644
--- a/doc/sphinx/api/config-test.json
+++ b/doc/sphinx/api/config-test.json
@@ -4,7 +4,7 @@
         "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
     ],
     "cmd-comment": [
-        "where &gt;server&lt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+        "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
     ],
     "cmd-syntax": [
         "{",
diff --git a/doc/sphinx/api2doc.py b/doc/sphinx/api2doc.py
index 55b9079a88..2dc60cc916 100755
--- a/doc/sphinx/api2doc.py
+++ b/doc/sphinx/api2doc.py
@@ -113,7 +113,7 @@ API Reference
 
         # command syntax
         rst += 'Command syntax:\n\n'
-        rst += '.. code-block:: \n\n'
+        rst += '::\n\n'
         if 'cmd-syntax' in func:
             cmd_syntaxes = [func['cmd-syntax']]
             if isinstance(cmd_syntaxes, dict):
@@ -139,7 +139,7 @@ API Reference
 
         # response syntax
         rst += 'Response syntax:\n\n'
-        rst += '.. code-block:: \n\n'
+        rst += '::\n\n'
         if 'resp-syntax' in func:
             resp_syntaxes = [func['resp-syntax']]
             if isinstance(resp_syntaxes, dict):