构建numpy API和参考文档

我们目前使用 Sphinx 为NumPy生成API和参考文档。你需要狮身人面像>=2.2.0。

如果您只想获取文档，请注意，可以在

有几种不同的格式。

指令

如果您通过git获得了numpy，还可以获取包含构建文档所需附加部件的git子模块：

git submodule update --init

此外，构建文档需要Sphinx扩展 plot_directive ，随附 Matplotlib. 可以通过安装Matplotlib来安装此Sphinx扩展。您还需要Python>=3.6。

因为大部分主要文档都是通过 import numpy 并且检查docstring，您将需要首先构建NumPy，并安装它以便导入正确的版本。

安装numpy后，安装scipy，因为随机模块中的某些绘图需要 scipy.special 正确地显示。

注意，您可以将NumPy安装到一个临时位置，并适当地设置PYTHONPATH环境变量。或者，如果使用Python虚拟环境（例如。 conda ， virtualenv 或 venv 模块），建议将numpy安装到新的虚拟环境中。构建NumPy文档所需的所有依赖项都可以通过以下方式安装：

pip install -r doc_requirements.txt

现在您已经准备好生成文档了，请编写：

make html

在 doc/ 目录。如果一切顺利，这将生成一个 build/html 包含生成文档的子目录。如果你收到关于 installed numpy != current repo git version ，则必须通过设置 GITVER 或者重新安装NumPy。

请注意，目前不支持在Windows上构建文档，尽管这应该是可能的。（见 Sphinx 有关详细信息，请参阅文档。）

要构建PDF文档，请执行以下操作：

make latex
make -C build/latex all-pdf

您需要为此安装Latex，包括对希腊字母的支持。例如，在Ubuntu xenial上 texlive-lang-greek 和 cm-super 是需要的。阿尔索 latexmk 在非Windows系统上需要。

除上述之外，您还可以执行以下操作：

make dist

它将重建numpy，将其安装到临时位置，并以所有格式构建文档。这很可能只在Unix平台上工作。

NumPy的文档在https://numpy.org/doc在html和pdf格式中，还构建了 make dist . 见 HOWTO RELEASE 有关如何更新的详细信息https://numpy.org/doc。

Sphinx伸展

numpy的文档使用了几个对sphinx的自定义扩展。这些是用 sphinxext/ 目录（如上所述，作为git子模块），并在构建numpy的文档时自动启用。

如果要在第三方项目中使用这些扩展，可以在 PyPi 作为 numpydoc 包裹。

NumPy文档指南 报告错误