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()

方法

run

属性

final_argument_whitespace

最后一个参数可以包含空格吗?

has_content

指令可以有内容吗?

objtype

option_spec

选项名称到验证器函数的映射。

optional_arguments

在必需参数之后的可选参数的数量。

required_arguments

所需的指令参数数量。

has_content = True

指令可以有内容吗?

required_arguments = 1

所需的指令参数数量。