mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 05:55:28 +00:00
Code Issues Releases Wiki Activity

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

Browse Source
This commit is contained in:
Andrei Pavel
2021-09-16 18:37:05 +03:00
committed by Tomek Mrugalski
parent 8f8c0fb6ac
commit 640ed86331
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/sphinx/api2doc.py
View File

@@ -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'