mirror of
https://github.com/ceph/ceph
synced 2025-01-09 12:42:31 +00:00
bd9b597242
instead of reusing "confval" directive, define a new directive just for configration sections Signed-off-by: Kefu Chai <kchai@redhat.com>
56 lines
1.4 KiB
Python
56 lines
1.4 KiB
Python
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,
|
|
)
|
|
]
|
|
)
|
|
app.add_object_type(
|
|
'confval_section',
|
|
'confval_section',
|
|
objname='configuration section',
|
|
indextemplate='pair: %s; configuration section',
|
|
doc_field_types=[
|
|
Field(
|
|
'example',
|
|
label=_('Example'),
|
|
has_arg=False,
|
|
)]
|
|
)
|
|
return {
|
|
'version': 'builtin',
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True,
|
|
}
|