添加文档¶

构建文档¶

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

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

首次构建文档时，该过程将需要几分钟，因为它需要通过读取和解析所有 Manim 内容，从头开始生成所有 .rst (reST: reStructured Text) 文件。下次构建时，由于它只重新构建已更改的部分，因此过程会快得多。

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

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

本网站使用的主题是 Furo。

Manim 实现了自定义指令，用于与 Autodoc 和 Autosummary 配合使用，这些指令在 docbuild 中定义。