From: Kefu Chai <kchai@redhat.com>
Date: Wed, 19 May 2021 14:35:36 +0000 (+0800)
Subject: doc/_ext: render :example: field of an option
X-Git-Tag: v17.1.0~1852^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a4c278a3a404fe0657aa284e8c96e6877a244dc5;p=ceph.git

doc/_ext: render :example: field of an option

some options have this fields in their document, let's render it as
well.

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/doc/_ext/ceph_confval.py b/doc/_ext/ceph_confval.py
index 33a4eb3f7b2d9..25a3f8bc7b238 100644
--- a/doc/_ext/ceph_confval.py
+++ b/doc/_ext/ceph_confval.py
@@ -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 %}