]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2067] ARM: remove dot before commands in API Ref
authorAndrei Pavel <andrei@isc.org>
Thu, 16 Sep 2021 15:37:05 +0000 (18:37 +0300)
committerTomek Mrugalski <tomek@isc.org>
Mon, 20 Sep 2021 18:16:50 +0000 (18:16 +0000)
doc/sphinx/api2doc.py

index 96d3d3597c9c246639ebf4aa2ade0e6089d34c04..4318fd2c622b756863ef7739329136c720ef4f64 100755 (executable)
@@ -88,10 +88,12 @@ API Reference
         rst += '.\n\n'
 
     for func in sorted(apis.values(), key=lambda f: f['name']):
-        # The dot is added to overcome an overlap of ordinal numbers and text
-        # in the table of contents.
-        name = '. ' + func['name']
+        # "name" is visible in the ARM. "real_name" is used to provide links
+        # to commands. Keep both even if they're the same for when you want to
+        # make changes to "name" to change the way it's seen in the ARM.
+        name = func['name']
         real_name = func['name']
+
         rst += '.. _ref-%s:\n\n' % real_name
         rst += name + '\n'
         rst += '-' * len(name) + '\n\n'