]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#809,!469] Sphinx generation fix. 809-sphinx-fix
authorTomek Mrugalski <tomasz@isc.org>
Wed, 7 Aug 2019 14:54:47 +0000 (16:54 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Wed, 7 Aug 2019 14:54:47 +0000 (16:54 +0200)
doc/sphinx/api/config-set.json
doc/sphinx/api/config-test.json
doc/sphinx/api2doc.py

index d0a61065166b7fd362dd4e1a94519f5276bf2dee..02fc74a7cfe498aaeccfc5bfda3a86fc5bb4aa6b 100644 (file)
@@ -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
+}
index 6399ca2bfd2887896ec0e1afc8f28dc6b17da48d..335d06e9dbf3854dda0dcae2728d1b69fb0f7c09 100644 (file)
@@ -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": [
         "{",
index 55b9079a88b03eb065a1b2acf39a812d5c38e487..2dc60cc91666b7ad524e89718470d5d3dd091f05 100755 (executable)
@@ -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):