diff options
| author | Georg Brandl <georg@python.org> | 2011-01-07 16:27:47 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-07 16:27:47 +0100 |
| commit | 7f9553ac8cf7aa2b5239dc809c659f0fd32593da (patch) | |
| tree | 56ac7a9723d8144239694fcb89836f1d5781c5c8 /doc/ext/appapi.rst | |
| parent | 4c1ad3a018fdfca4a6fe489fa7da6dae92d7a10f (diff) | |
| download | sphinx-7f9553ac8cf7aa2b5239dc809c659f0fd32593da.tar.gz | |
Parse parmeter field in event descriptions.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 8f2a779b..302013da 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -163,7 +163,8 @@ the following public API: .. versionadded:: 0.6 -.. method:: Sphinx.add_object_type(directivename, rolename, indextemplate='', parse_node=None, ref_nodeclass=None, objname='') +.. method:: Sphinx.add_object_type(directivename, rolename, indextemplate='', parse_node=None, \ + ref_nodeclass=None, objname='', doc_field_types=[]) This method is a very convenient way to add a new :term:`object` type that can be cross-referenced. It will do this: |