RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-03-11 02:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/_ext: extract confval into an extension

Browse Source 
better readability this way

Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2021-04-15 00:03:10 +08:00
parent 4968baa252
commit 4b6a3f8161
2 changed files with 44 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/_ext/ceph_confval.py Normal file
View File

@ -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,
}

38
doc/conf.py
View File

@ -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,
)
]
)