本文整理汇总了Python中sphinx.addnodes.desc_name方法的典型用法代码示例。如果您正苦于以下问题:Python addnodes.desc_name方法的具体用法?Python addnodes.desc_name怎么用?Python addnodes.desc_name使用的例子?那么恭喜您, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类sphinx.addnodes
的用法示例。
在下文中一共展示了addnodes.desc_name方法的15个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
m = re.match(r'([a-zA-Z0-9_/\(\):]+)\(([a-zA-Z0-9,\'"_= ]*)\)', sig)
if not m:
signode += addnodes.desc_name(sig, sig)
return sig
uri_path, args = m.groups()
signode += addnodes.desc_name(uri_path, uri_path)
plist = DescRPCArgumentList()
args = args.split(',')
for pos, arg in enumerate(args):
arg = arg.strip()
if pos < len(args) - 1:
arg += ','
x = DescRPCArgument()
x += addnodes.desc_parameter(arg, arg)
plist += x
signode += plist
return uri_path
示例2: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
match = re.match(r'(?P<name>[a-zA-Z0-9]+)(\((?P<arguments>[a-z_0-9]+(, +[a-z_0-9]+)*)\))?', sig)
field_name = match.group('name')
if 'gql:object' in self.env.ref_context:
full_name = self.env.ref_context['gql:object'] + '.' + field_name
else:
full_name = field_name
signode += addnodes.desc_name(field_name, field_name)
arguments = match.group('arguments')
if arguments:
plist = DescGraphQLFieldArgumentList()
arguments = arguments.split(',')
for pos, arg in enumerate(arguments):
arg = arg.strip()
if pos < len(arguments) - 1:
arg += ','
x = DescGraphQLFieldArgument()
x += addnodes.desc_parameter(arg, arg)
plist += x
signode += plist
return full_name
示例3: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
match = re.match(r'(?P<name>[a-z0-9_]+)(\((?P<arguments>[a-z_0-9]+(, +[a-z_0-9]+)*)\))?', sig)
field_name = match.group('name')
if 'db:table' in self.env.ref_context:
full_name = self.env.ref_context['db:table'] + '.' + field_name
else:
full_name = field_name
signode += addnodes.desc_name(field_name, field_name)
arguments = match.group('arguments')
if arguments:
plist = DescDatabaseFieldArgumentList()
arguments = arguments.split(',')
for pos, arg in enumerate(arguments):
arg = arg.strip()
if pos < len(arguments) - 1:
arg += ','
x = DescDatabaseFieldArgument()
x += addnodes.desc_parameter(arg, arg)
plist += x
signode += plist
return full_name
示例4: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self,sig,signode):
sig = sig.strip()
type_name, name, arglist = protobuf_sig_regex.match(sig).groups()
if self.prefix:
signode += addnodes.desc_annotation(self.prefix+' ', self.prefix+' ')
if type_name:
signode += addnodes.desc_type(type_name, type_name)
if name:
signode += addnodes.desc_name(name,name)
if arglist:
paramlist = addnodes.desc_parameterlist()
for arg in arglist.split(','):
argtype, argname = arg.split(None,1)
param = addnodes.desc_parameter(noemph=True)
param += nodes.Text(argtype,argtype)
param += nodes.emphasis(' '+argname,' '+argname)
paramlist += param
signode += paramlist
return name
示例5: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
if '::' in sig:
mod, name = sig.strip().split('::')
else:
name = sig.strip()
mod = 'std'
display = name.replace('-', ' ')
if mod != 'std':
display = f'{mod}::{display}'
signode['eql-module'] = mod
signode['eql-name'] = name
signode['eql-fullname'] = fullname = f'{mod}::{name}'
signode += s_nodes.desc_annotation('type', 'type')
signode += d_nodes.Text(' ')
signode += s_nodes.desc_name(display, display)
return fullname
示例6: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
if "::" in sig:
name, descr = map(lambda i: i.strip(), sig.split("::"))
else:
name, descr = sig.strip(), ""
signode["name"] = name
signode["descr"] = descr
domain, objtype = self.name.split(":")
if objtype == "section":
self.env.temp_data["section"] = signode["name"]
name = "[%s]" % signode["name"]
signode += addnodes.desc_name(name, name)
return signode["name"]
示例7: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
"""Transform a PicoBlaze signature into RST nodes."""
m = pb_sig_re.match(sig)
if m is None:
raise ValueError('no match')
name, arglist = m.groups()
signode += addnodes.desc_name(name, name)
if not arglist:
if self.objtype in ('function', 'macro'):
# for functions and macros, add an empty parameter list
signode += addnodes.desc_parameterlist()
self.env.domains['pb'].data['has_params'][name] = False
return name
_parse_arglist(signode, arglist)
self.env.domains['pb'].data['has_params'][name] = True
return name
示例8: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
modifiers, typ, name, getter, setter = parse_property_signature(sig)
self.append_modifiers(signode, modifiers)
self.append_type(signode, typ)
signode += nodes.Text(' ')
signode += addnodes.desc_name(name, name)
signode += nodes.Text(' { ')
extra = []
if getter:
extra.append('get;')
if setter:
extra.append('set;')
extra_str = ' '.join(extra)
signode += addnodes.desc_annotation(extra_str, extra_str)
signode += nodes.Text(' }')
return self.get_fullname(name)
示例9: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
fullname = sig
signode += addnodes.desc_annotation('config ', 'config ')
signode += addnodes.desc_name(sig, '', nodes.Text(sig))
return fullname
示例10: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
signode.clear()
signode += addnodes.desc_name(sig, sig)
return ws_re.sub('', sig)
示例11: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig: str, signode: addnodes.desc) -> str:
"""Transform signature into RST nodes"""
signode += addnodes.desc_annotation(self.typename, self.typename + " ")
signode += addnodes.desc_name(sig, sig)
if 'badges' in self.options:
badges = addnodes.desc_annotation()
badges['classes'] += ['badges']
content = StringList([self.options['badges']])
self.state.nested_parse(content, 0, badges)
signode += badges
if 'replaces_section_title' in self.options:
section = self.state.parent
if isinstance(section, nodes.section):
title = section[-1]
if isinstance(title, nodes.title):
section.remove(title)
else:
signode += self.state.document.reporter.warning(
"%s:%s:: must follow section directly to replace section title"
% (self.domain, self.objtype), line = self.lineno
)
else:
signode += self.state.document.reporter.warning(
"%s:%s:: must be in section to replace section title"
% (self.domain, self.objtype), line = self.lineno
)
return sig
示例12: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
method = self.method.upper() + ' '
signode += addnodes.desc_name(method, method)
offset = 0
path = None
for match in http_sig_param_re.finditer(sig):
path = sig[offset:match.start()]
signode += addnodes.desc_name(path, path)
params = addnodes.desc_parameterlist()
typ = match.group('type')
if typ:
typ += ': '
params += addnodes.desc_annotation(typ, typ)
name = match.group('name')
params += addnodes.desc_parameter(name, name)
signode += params
offset = match.end()
if offset < len(sig):
path = sig[offset:len(sig)]
signode += addnodes.desc_name(path, path)
assert path is not None, 'no matches for sig: %s' % sig
fullname = self.method.upper() + ' ' + path
signode['method'] = self.method
signode['path'] = sig
signode['fullname'] = fullname
return (fullname, self.method, sig)
示例13: get_sections_and_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def get_sections_and_signature(need_info):
"""Gets the hierarchy of the section nodes as a list starting at the
section of the current need and then its parent sections"""
sections = []
signature = None
current_node = need_info['target_node']
while current_node:
if isinstance(current_node, nodes.section):
title = current_node.children[0].astext()
# If using auto-section numbering, then Sphinx inserts
# multiple non-breaking space unicode characters into the title
# we'll replace those with a simple space to make them easier to
# use in filters
title = NON_BREAKING_SPACE.sub(' ', title)
sections.append(title)
# Checking for a signature defined "above" the need.
# Used and set normally by directives like automodule.
# Only check as long as we haven't found a signature
if signature is None and current_node.parent is not None and current_node.parent.children is not None:
for sibling in current_node.parent.children:
# We want to check only "above" current node, so no need to check sibling after current_node.
if sibling == current_node:
break
if isinstance(sibling, desc_signature):
# Check the child of the found signature for the text content/node.
for desc_child in sibling.children:
if isinstance(desc_child, desc_name) and \
isinstance(desc_child.children[0], nodes.Text):
signature = desc_child.children[0]
if signature is not None:
break
current_node = getattr(current_node, 'parent', None)
return sections, signature
示例14: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def handle_signature(self, sig, signode):
method = self.method.upper() + " "
signode += addnodes.desc_name(method, method)
offset = 0
path = None
for match in http_sig_param_re.finditer(sig):
path = sig[offset : match.start()]
signode += addnodes.desc_name(path, path)
params = addnodes.desc_parameterlist()
typ = match.group("type")
if typ:
typ += ": "
params += addnodes.desc_annotation(typ, typ)
name = match.group("name")
params += addnodes.desc_parameter(name, name)
signode += params
offset = match.end()
if offset < len(sig):
path = sig[offset : len(sig)]
signode += addnodes.desc_name(path, path)
if path is None:
assert False, "no matches for sig: %s" % sig
fullname = self.method.upper() + " " + path
signode["method"] = self.method
signode["path"] = sig
signode["fullname"] = fullname
return (fullname, self.method, sig)
示例15: parse_django_admin_node
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_name [as 别名]
def parse_django_admin_node(env, sig, signode):
command = sig.split(' ')[0]
env.ref_context['std:program'] = command
title = "django-admin %s" % sig
signode += addnodes.desc_name(title, title)
return command