本文整理汇总了Python中sphinx.addnodes.desc_addname方法的典型用法代码示例。如果您正苦于以下问题：Python addnodes.desc_addname方法的具体用法？Python addnodes.desc_addname怎么用？Python addnodes.desc_addname使用的例子？那么恭喜您, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类sphinx.addnodes的用法示例。
在下文中一共展示了addnodes.desc_addname方法的5个代码示例，这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞，您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_addname [as 别名]
def handle_signature(self, sig, signode):
name = sig
config = self.options.get('config', self.env.ref_context.get('cfg:config', ""))
if not config:
logger.warning("config option with unknown config", location=signode)
config = "UNKNOWN"
fullname = config + '.' + name
signode += addnodes.desc_annotation('option ', 'option ')
if not self.env.ref_context.get('cfg:in-config', False):
signode += addnodes.pending_xref(sig,
addnodes.desc_addname(config, config),
refdomain='cfg',
reftype='config',
reftarget=config)
signode += addnodes.desc_addname('', '.')
signode += addnodes.desc_name(sig, '', nodes.Text(sig))
typ = self.options.get('type')
if typ:
type_node = addnodes.desc_annotation(': ', ': ')
info = self.content.parent.info(1) # might be off by a few lines...
type_node.extend(_parse_inline(self.state, typ, info))
signode += type_node
defaultvalue = self.options.get('default')
if defaultvalue:
val_node = addnodes.desc_annotation(' = ', ' = ')
val_node += nodes.literal(defaultvalue, defaultvalue)
signode += val_node
return fullname, config 示例2: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_addname [as 别名]
def handle_signature(self, sig, signode):
signode += addnodes.desc_addname(sig, sig)
return sig 示例3: append_indexer_parameters
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_addname [as 别名]
def append_indexer_parameters(self, node, params):
pnodes = addnodes.desc_addname()
pnodes += nodes.Text('[')
for param in params:
if pnodes.children:
pnodes += nodes.Text(u', ')
self.append_type(pnodes, param.typ)
pnodes += nodes.Text(u' ')
pnodes += nodes.emphasis(param.name, param.name)
pnodes += nodes.Text(']')
node += pnodes 示例4: handle_signature
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_addname [as 别名]
def handle_signature(self, sig, signode):
methods, path = sig
signode += addnodes.desc_annotation('endpoint ', 'endpoint ')
signode += addnodes.desc_addname(methods + ' ', methods + ' ')
signode += addnodes.desc_name(path, path) 示例5: make_process_header
# 需要导入模块: from sphinx import addnodes [as 别名]
# 或者: from sphinx.addnodes import desc_addname [as 别名]
def make_process_header(self, slug, typ, version, source_uri, description, inputs):
"""Generate a process definition header.
:param str slug: process' slug
:param str typ: process' type
:param str version: process' version
:param str source_uri: url to the process definition
:param str description: process' description
:param dict inputs: process' inputs
"""
node = addnodes.desc()
signode = addnodes.desc_signature(slug, "")
node.append(signode)
node["objtype"] = node["desctype"] = typ
signode += addnodes.desc_annotation(typ, typ, classes=["process-type"])
signode += addnodes.desc_addname("", "")
signode += addnodes.desc_name(slug + " ", slug + " ")
paramlist = addnodes.desc_parameterlist()
for field_schema, _, _ in iterate_schema({}, inputs, ""):
field_type = field_schema["type"]
field_name = field_schema["name"]
field_default = field_schema.get("default", None)
field_default = "" if field_default is None else "={}".format(field_default)
param = addnodes.desc_parameter("", "", noemph=True)
param += nodes.emphasis(field_type, field_type, classes=["process-type"])
# separate by non-breaking space in the output
param += nodes.strong(text="\xa0\xa0" + field_name)
paramlist += param
signode += paramlist
signode += nodes.reference(
"",
nodes.Text("[Source: v{}]".format(version)),
refuri=source_uri,
classes=["viewcode-link"],
)
desc = nodes.paragraph()
desc += nodes.Text(description, description)
return [node, desc]