From: Kefu Chai <kchai@redhat.com>
Date: Wed, 14 Apr 2021 16:03:10 +0000 (+0800)
Subject: doc/_ext: extract confval into an extension
X-Git-Tag: v17.1.0~2249^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F40847%2Fhead;p=ceph.git

doc/_ext: extract confval into an extension

better readability this way

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

diff --git a/doc/_ext/ceph_confval.py b/doc/_ext/ceph_confval.py
new file mode 100644
index 000000000000..e30f374523e4
--- /dev/null
+++ b/doc/_ext/ceph_confval.py
@@ -0,0 +1,43 @@
+from sphinx.domains.python import PyField
+from sphinx.locale import _
+from sphinx.util.docfields import Field
+
+
+def setup(app):
+    app.add_object_type(
+        'confval',
+        'confval',
+        objname='configuration value',
+        indextemplate='pair: %s; configuration value',
+        doc_field_types=[
+            PyField(
+                'type',
+                label=_('Type'),
+                has_arg=False,
+                names=('type',),
+                bodyrolename='class'
+            ),
+            Field(
+                'default',
+                label=_('Default'),
+                has_arg=False,
+                names=('default',),
+            ),
+            Field(
+                'required',
+                label=_('Required'),
+                has_arg=False,
+                names=('required',),
+            ),
+            Field(
+                'example',
+                label=_('Example'),
+                has_arg=False,
+            )
+        ]
+    )
+    return {
+        'version': 'builtin',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }
diff --git a/doc/conf.py b/doc/conf.py
index ad36c0950f8d..682294db212f 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -6,10 +6,6 @@ import sys
 import yaml
 import sphinx.util
 
-from sphinx.domains.python import PyField
-from sphinx.locale import _
-from sphinx.util.docfields import Field
-
 
 top_level = \
     os.path.dirname(
@@ -123,6 +119,7 @@ extensions = [
     'breathe',
     'ceph_commands',
     'ceph_releases',
+    'ceph_confval',
     'sphinxcontrib.openapi'
     ]
 
@@ -240,36 +237,3 @@ def setup(app):
                 generate_state_diagram(['src/osd/PeeringState.h',
                                         'src/osd/PeeringState.cc'],
                                        'doc/dev/peering_graph.generated.dot'))
-
-    app.add_object_type(
-        'confval',
-        'confval',
-        objname='configuration value',
-        indextemplate='pair: %s; configuration value',
-        doc_field_types=[
-            PyField(
-                'type',
-                label=_('Type'),
-                has_arg=False,
-                names=('type',),
-                bodyrolename='class'
-            ),
-            Field(
-                'default',
-                label=_('Default'),
-                has_arg=False,
-                names=('default',),
-            ),
-            Field(
-                'required',
-                label=_('Required'),
-                has_arg=False,
-                names=('required',),
-            ),
-            Field(
-                'example',
-                label=_('Example'),
-                has_arg=False,
-            )
-        ]
-    )