由Sphinx添加的Doctree节点类

特定于域的对象描述的节点

class sphinx.addnodes.desc(rawsource='', *children, **attributes)

用于对象描述的节点。

此节点类似于具有一个定义的 “definition list” 。 它包含一个或多个 desc_signature 和 desc_content 。

class sphinx.addnodes.desc_signature(rawsource='', text='', *children, **attributes)

用于对象签名的节点。

自定义Sphinx定义列表的 “term” 部分。

默认情况下，签名是单行签名，但设置 is_multiline = True 来描述多行签名。在这种情况下，所有子节点必须是 desc_signature_line 节点。

class sphinx.addnodes.desc_signature_line(rawsource='', text='', *children, **attributes)

多行对象签名中的行的节点。

它只应用于 desc_signature 并设置 is_multiline 。 为应该获得永久链接的行设置 add_permalink = True 。

class sphinx.addnodes.desc_addname(rawsource='', text='', *children, **attributes)

其他名称部分的节点(模块名称，类名称)。

class sphinx.addnodes.desc_type(rawsource='', text='', *children, **attributes)

返回类型或对象类型名称的节点。

class sphinx.addnodes.desc_returns(rawsource='', text='', *children, **attributes)

用于 “返回” 注释的节点(Python中的 -> la)。

class sphinx.addnodes.desc_name(rawsource='', text='', *children, **attributes)

节点为主对象名称。

class sphinx.addnodes.desc_parameterlist(rawsource='', text='', *children, **attributes)

用于常规参数列表的节点。

class sphinx.addnodes.desc_parameter(rawsource='', text='', *children, **attributes)

单个参数的节点。

class sphinx.addnodes.desc_optional(rawsource='', text='', *children, **attributes)

用于标记参数列表的可选部分的节点。

class sphinx.addnodes.desc_annotation(rawsource='', text='', *children, **attributes)

用于签名注释的节点(不是 Python 3 样式的注释)。

class sphinx.addnodes.desc_content(rawsource='', *children, **attributes)

用于对象描述内容的节点。

这是自定义Sphinx定义列表的 “定义” 部分。

新的告诫式结构

class sphinx.addnodes.versionmodified(rawsource='', text='', *children, **attributes)

用于版本更改条目的节点。

目前用于 “versionadded ” ， “versionchanged” 和 “deprecated” 指令。

class sphinx.addnodes.seealso(rawsource='', *children, **attributes)

自定义 “另见” 告诫。

其他段落级节点

class sphinx.addnodes.compact_paragraph(rawsource='', text='', *children, **attributes)

紧凑段落的节点(从不创建<p>节点)。

新的内联节点

class sphinx.addnodes.index(rawsource='', text='', *children, **attributes)

索引条目的节点。

该节点由 index 指令创建，并具有一个属性 entries 。它的值是一个5元组的列表 (entrytype，entryname，target，ignored，key) 。

entrytype 是 “single” ，”pair” ， “double ” ， “triple” 之一。

key 是一般索引页面的分类字符(通常是单个字符)。有关详细信息，请参阅: glossary 和 issue ＃2320。

class sphinx.addnodes.pending_xref(rawsource='', *children, **attributes)

没有关于所有文档的完整信息的交叉引用节点。

在BuildEnvironment.resolve_references中写入输出之前解析这些节点。

class sphinx.addnodes.literal_emphasis(rawsource='', text='', *children, **attributes)

行为类似于 emphasis 的节点，但不应用其他文本处理器(例如，用于HTML输出的智能型)。

class sphinx.addnodes.abbreviation(rawsource='', text='', *children, **attributes)

带有解释的缩写节点。

2.0 版后已移除.

class sphinx.addnodes.download_reference(rawsource='', text='', *children, **attributes)

用于下载引用的节点，类似于pending_xref。

特殊节点

class sphinx.addnodes.only(rawsource='', *children, **attributes)

“仅”指令的节点(基于标签的条件包含)。

class sphinx.addnodes.meta(rawsource='', *children, **attributes)

meta指令的节点 - 与docutils的标准元节点相同，但是pickleable。

class sphinx.addnodes.highlightlang(rawsource='', *children, **attributes)

已插入以设置后续代码块的高亮语言和行号选项。

您不需要在扩展中生成下面的节点。

class sphinx.addnodes.glossary(rawsource='', *children, **attributes)

节点插入词汇表。

class sphinx.addnodes.toctree(rawsource='', *children, **attributes)

用于插入 “TOC树” 的节点。

class sphinx.addnodes.start_of_file(rawsource='', *children, **attributes)

用于标记新文件的开始的节点，仅在LaTeX构建器中使用。

class sphinx.addnodes.productionlist(rawsource='', *children, **attributes)

用于语法生成列表的节点。

Contains production nodes.

class sphinx.addnodes.production(rawsource='', text='', *children, **attributes)

单个语法生成规则的节点。