]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/_ext: render :example: field of an option
authorKefu Chai <kchai@redhat.com>
Wed, 19 May 2021 14:35:36 +0000 (22:35 +0800)
committerKefu Chai <kchai@redhat.com>
Tue, 25 May 2021 12:56:37 +0000 (20:56 +0800)
some options have this fields in their document, let's render it as
well.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/_ext/ceph_confval.py

index 33a4eb3f7b2d9647a598f27c4c4ff5a5fa99a420..25a3f8bc7b23897ffdc8bb7491de05cd09bbd4ca 100644 (file)
@@ -62,6 +62,9 @@ TEMPLATE = '''
 {%- if opt.policies %}
    :policies: {{ opt.policies }}
 {% endif %}
+{%- if opt.example %}
+   :example: {{ opt.example }}
+{%- endif %}
 {%- if opt.see_also %}
    :see also: {{ opt.see_also | map('ref_confval') | join(', ') }}
 {%- endif %}