添加文档¶

构建文档¶

当你从GitHub克隆Manim仓库时，你可以访问docs/文件夹，其中包含构建文档所需的文件。

要在本地构建文档，请打开命令行界面，使用cd命令进入docs/文件夹，然后根据您的操作系统执行以下操作：

第一次构建文档时，这个过程将需要几分钟，因为它需要从头开始通过读取和解析所有Manim内容生成所有的.rst（reST：reStructured Text）文件。下次这个过程会变得短得多，因为它只重建已更改的部分。

Manim 使用 Sphinx 来构建文档。它还使用了 Sphinx 扩展，例如：

Autodoc: 导入Manim的Python源代码，提取其文档字符串并从中生成文档。
Autosummary: Autodoc 的补充，添加了一个特殊的指令 autosummary，在 Manim 中用于自动记录类、方法、属性、函数、模块级变量和异常。 Autosummary 使用了 Jinja 模板， Manim 在 docs/source/_templates/ 中定义了用于自动汇总类和模块的模板。
Graphviz extension for Sphinx: 嵌入由Graphviz模块生成的图表，必须安装该模块才能渲染参考手册中的继承图。
拿破仑: 使Sphinx能够读取Google风格的文档字符串，特别是对于Manim，NumPy风格的文档字符串 - 更多信息请参见添加文档字符串。

本网站使用的主题是Furo。

Manim 实现了用于 Autodoc 和 Autosummary 的自定义指令，这些指令在 docbuild 中定义：