AliasAttrDocumenter

限定名称：manim.utils.docbuild.autoaliasattr\_directive.AliasAttrDocumenter

class AliasAttrDocumenter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

基类: Directive

取代 Sphinx 的 Autosummary 用于模块级属性的指令：相反，它手动创建了一个新的“类型别名”部分，其中所有明确标注为 TypeAlias 的模块级属性都被视为类型别名，以便它们在 Manim 文档中得到广泛使用。

这些类型别名与“常规”模块级属性是分开的，后者在“类型别名”下通过 Sphinx 的 Autosummary 自动生成其传统的“模块属性”部分。

请参阅 docs/source/_templates/autosummary/module.rst 查看此指令的实际应用。

有关模块如何被解析以获取 TypeAlias 信息并将其与其他属性分离的更多信息，请参阅 parse_module_attributes()。

方法

运行

属性

最终参数空格	最终参数可以包含空格吗？
包含内容	该指令可以包含内容吗？
对象类型
选项规范	选项名称到验证器函数的映射。
可选参数	必选参数后的可选参数数量。
必选参数	必选指令参数的数量。

has_content = True

该指令可以包含内容吗？

required_arguments = 1

必选指令参数的数量。