autoaliasattr_directive

用于文档化类型别名和其他模块级属性的指令。

AliasAttrDocumenter

一个指令,用于替换 Sphinx 的 Autosummary 在模块级属性方面的功能:它手动创建一个新的“类型别名”部分,其中所有被明确标注为 TypeAlias 的模块级属性都被视为类型别名,以便在 Manim 文档中广泛使用。

函数

setup(app)[源码]
参数:

app (Sphinx)

返回类型:

smart_replace(base, alias, substitution)[源码]

一个辅助函数,用于将类型别名替换到基本字符串中,当别名之间存在重叠时。

参数:
  • base (str) – 将要定位并替换类型别名的字符串。

  • alias (str) – 将被替换的子字符串。

  • substitution (str) – 将替换所有 alias 出现处的字符串。

返回:

别名替换后的新字符串。

返回类型:

str