From: Andrei Pavel <andrei@isc.org>
Date: Thu, 16 Sep 2021 15:37:05 +0000 (+0300)
Subject: [#2067] ARM: remove dot before commands in API Ref
X-Git-Tag: Kea-2.0.0~104
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=640ed863314ae8f534d607b37576f7b4c1d9401c;p=thirdparty%2Fkea.git

[#2067] ARM: remove dot before commands in API Ref
---

diff --git a/doc/sphinx/api2doc.py b/doc/sphinx/api2doc.py
index 96d3d3597c..4318fd2c62 100755
--- a/doc/sphinx/api2doc.py
+++ b/doc/sphinx/api2doc.py
@@ -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'