构建 NumPy API 和参考文档#

如果您只想获取文档，请注意可以在以下位置找到预构建版本：

有几种不同的格式。

开发环境#

在继续之前，应该注意的是，该文档是使用该make工具构建的，该工具在 Windows 上本身不可用。 MacOS 或 Linux 用户可以跳转到先决条件。建议 Windows 用户在 GitHub Codespaces（请参阅推荐的开发设置）或 Windows Subsystem for Linux (WSL)上设置其开发环境。 WSL 是持久本地设置的不错选择。

先决条件#

构建 NumPy 文档和 API 参考需要以下内容：

numpy #

由于主要文档的大部分是通过检查文档字符串从 NumPy 获取的，因此您需要首先构建并安装它，以便导入正确的版本。每次获取最新版本的存储库时，在生成文档之前，都必须重新构建并重新安装 NumPy。这可确保 NumPy 版本和 git 存储库版本同步。import numpy

请注意，您可以将 NumPy 安装到临时位置并适当设置 PYTHONPATH 环境变量。或者，如果使用 Python 虚拟环境（例如通过conda或 virtualenv模块venv），建议将 NumPy 安装到新的虚拟环境中。

依赖项#

除了Doxygen之外，构建 NumPy 文档所需的所有依赖项都可以通过以下方式安装：

pip install -r doc_requirements.txt

目前，我们使用Sphinx和Doxygen来生成 NumPy 的 API 和参考文档。此外，构建文档需要 Sphinx 扩展plot_directive，它随 Matplotlib一起提供。我们还使用numpydoc在生成的 API 文档中呈现文档字符串。由于文档的某些部分需要 SciPy 函数，因此安装了SciPy 。

要安装Doxygen，请检查官方下载和安装页面，或者如果您使用的是 Linux，则可以通过分发包管理器安装它。

笔记

尝试安装较新版本的Doxygen > 1.8.10，否则您可能会在构建过程中收到一些警告。

子模块#

如果您通过 git 获取了 NumPy，还可以获取包含构建文档所需的其他部分的 git 子模块：

git submodule update --init

指示＃

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

spin docs

如果您还没有的话，这将从源代码构建 NumPy，并运行 Sphinx 来构建html文档。如果一切顺利，这将build/html 在目录中生成一个子目录/doc，其中包含构建的文档。

在/doc上以 html 和 pdf 格式分发的 NumPy 文档也是使用.有关如何更新/doc 的详细信息，请参阅HOWTO RELEASE。make dist