IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#37: link to exception in :raises X: doc field.

Browse Source
This commit is contained in:
Georg Brandl 2008-11-16 09:16:34 +01:00
parent 45cb5475c0
commit 516cc73450
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
sphinx/directives/desc.py
View File

@ -108,6 +108,8 @@ doc_fields_with_arg = {
'return': 'Returns', 'return': 'Returns',
} }
doc_fields_with_linked_arg = ('raises', 'raise', 'exception', 'except')
doc_fields_without_arg = { doc_fields_without_arg = {
'returns': 'Returns', 'returns': 'Returns',
'return': 'Returns', 'return': 'Returns',
@ -116,7 +118,7 @@ doc_fields_without_arg = {
del _ del _
def handle_doc_fields(node): def handle_doc_fields(node, env):
# don't traverse, only handle field lists that are immediate children # don't traverse, only handle field lists that are immediate children
for child in node.children: for child in node.children:
if not isinstance(child, nodes.field_list): if not isinstance(child, nodes.field_list):
@ -129,13 +131,13 @@ def handle_doc_fields(node):
fname, fbody = field fname, fbody = field
try: try:
typ, obj = fname.astext().split(None, 1) typ, obj = fname.astext().split(None, 1)
typ = _(doc_fields_with_arg[typ]) typdesc = _(doc_fields_with_arg[typ])
if len(fbody.children) == 1 and \ if len(fbody.children) == 1 and \
isinstance(fbody.children[0], nodes.paragraph): isinstance(fbody.children[0], nodes.paragraph):
children = fbody.children[0].children children = fbody.children[0].children
else: else:
children = fbody.children children = fbody.children
if typ == '%param': if typdesc == '%param':
if not params: if not params:
pfield = nodes.field() pfield = nodes.field()
pfield += nodes.field_name('', _('Parameters')) pfield += nodes.field_name('', _('Parameters'))
@ -151,12 +153,22 @@ def handle_doc_fields(node):
param_nodes[obj] = dlpar param_nodes[obj] = dlpar
dlitem += dlpar dlitem += dlpar
params += dlitem params += dlitem
elif typ == '%type': elif typdesc == '%type':
param_types[obj] = fbody.astext() param_types[obj] = fbody.astext()
else: else:
fieldname = typ + ' ' + obj fieldname = typdesc + ' '
nfield = nodes.field() nfield = nodes.field()
nfield += nodes.field_name(fieldname, fieldname) nfieldname = nodes.field_name(fieldname, fieldname)
nfield += nfieldname
node = nfieldname
if typ in doc_fields_with_linked_arg:
node = addnodes.pending_xref(obj, reftype='obj',
refcaption=False,
reftarget=obj,
modname=env.currmodule,
classname=env.currclass)
nfieldname += node
node += nodes.Text(obj, obj)
nfield += nodes.field_body() nfield += nodes.field_body()
nfield[1] += fbody.children nfield[1] += fbody.children
new_list += nfield new_list += nfield
@ -479,7 +491,7 @@ def desc_directive(desctype, arguments, options, content, lineno,
if names: if names:
env.currdesc = names[0] env.currdesc = names[0]
state.nested_parse(content, content_offset, subnode) state.nested_parse(content, content_offset, subnode)
handle_doc_fields(subnode) handle_doc_fields(subnode, env)
if clsname_set: if clsname_set:
env.currclass = None env.currclass = None
env.currdesc = None env.currdesc = None