From 295a5f282710efa7c3815faaa3919f1018d04066 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Tue, 25 May 2021 10:53:01 -0400 Subject: [PATCH] doc/_ext/ceph_commands: handle non-positional args in docs Signed-off-by: Sage Weil --- doc/_ext/ceph_commands.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/_ext/ceph_commands.py b/doc/_ext/ceph_commands.py index eec031ee3d2ab..046a5e09c398c 100644 --- a/doc/_ext/ceph_commands.py +++ b/doc/_ext/ceph_commands.py @@ -82,7 +82,7 @@ class CmdParam(object): def __init__(self, type, name, who=None, n=None, req=True, range=None, strings=None, - goodchars=None): + goodchars=None, positional=True): self.type = type self.name = name self.who = who @@ -91,6 +91,7 @@ class CmdParam(object): self.range = range.split('|') if range else [] self.strings = strings.split('|') if strings else [] self.goodchars = goodchars + self.positional = positional != 'false' assert who == None @@ -200,7 +201,7 @@ TEMPLATE = ''' {%- if command.params %} :Parameters:{% for param in command.params -%} -{{" -" | indent(12, not loop.first) }} **{{param.name}}**: {{ param.help() }} +{{" -" | indent(12, not loop.first) }} **{% if param.positional %}{{param.name}}{% else %}--{{param.name}}{% endif %}**: {{ param.help() }} {% endfor %} {% endif %} :Ceph Module: {{ command.module }} -- 2.39.5