summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-01-07 16:27:47 +0100
committerGeorg Brandl <georg@python.org>2011-01-07 16:27:47 +0100
commit7f9553ac8cf7aa2b5239dc809c659f0fd32593da (patch)
tree56ac7a9723d8144239694fcb89836f1d5781c5c8 /doc/conf.py
parent4c1ad3a018fdfca4a6fe489fa7da6dae92d7a10f (diff)
downloadsphinx-7f9553ac8cf7aa2b5239dc809c659f0fd32593da.tar.gz
Parse parmeter field in event descriptions.
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/conf.py b/doc/conf.py
index aecd4f6d..ee94ed9e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -92,8 +92,12 @@ def parse_event(env, sig, signode):
def setup(app):
from sphinx.ext.autodoc import cut_lines
+ from sphinx.util.docfields import GroupedField
app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
- app.add_description_unit('confval', 'confval',
- objname='configuration value',
- indextemplate='pair: %s; configuration value')
- app.add_description_unit('event', 'event', 'pair: %s; event', parse_event)
+ app.add_object_type('confval', 'confval',
+ objname='configuration value',
+ indextemplate='pair: %s; configuration value')
+ fdesc = GroupedField('parameter', label='Parameters',
+ names=['param'], can_collapse=True)
+ app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
+ doc_field_types=[fdesc])