构建 NumPy API 和参考文档#
如果您只想获取文档，请注意，预构建的版本可以在
以几种不同的格式找到。
开发环境#
在继续深入之前，应注意文档是使用 make 工具构建的，该工具在 Windows 上不原生可用。MacOS 或 Linux 用户可以跳转到 先决条件。建议 Windows 用户在 GitHub Codespaces（参见 推荐的开发设置）或 Windows Subsystem for Linux (WSL) 上设置他们的开发环境。WSL 是一个持久化本地设置的好选择。
先决条件#
构建 NumPy 文档和 API 参考需要以下
NumPy#
由于主文档的大部分内容是通过 import numpy 和检查 docstrings 从 NumPy 获取的，因此您需要先 构建 并安装它，以便导入正确的版本。每次获取存储库的最新版本时，都需要重新构建和重新安装 NumPy，然后再生成文档。这确保了 NumPy 版本和 git 存储库版本是同步的。
请注意，您可以将 NumPy 安装到临时位置，并相应地设置 PYTHONPATH 环境变量。或者，如果您使用 Python 虚拟环境（通过例如 conda、virtualenv 或 venv 模块），建议将 NumPy 安装到新的虚拟环境中。
依赖项#
除了 Doxygen 之外，构建 NumPy 文档所需的所有必要依赖项都可以使用以下命令安装：
pip install -r requirements/doc_requirements.txt
注意
在本地构建文档时，可能需要安装文档依赖项的开发版本。
pip install --pre --force-reinstall --extra-index-url \
https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
-r requirements/doc_requirements.txt
我们目前使用 Sphinx 以及 Doxygen 来生成 NumPy 的 API 和参考文档。此外，构建文档还需要 Sphinx 扩展 plot_directive，该扩展随 Matplotlib 一起提供。我们还使用 numpydoc 来渲染生成的 API 文档中的 docstrings。SciPy 被安装，因为文档的某些部分需要 SciPy 函数。
要安装 Doxygen，请查看官方的 下载 和 安装 页面，或者如果您使用的是 Linux，则可以通过您的发行版包管理器安装它。
注意
尝试安装更新版本的 Doxygen > 1.8.10，否则在构建过程中可能会收到一些警告。
子模块#
如果您通过 git 获取 NumPy，请同时获取包含构建文档所需的附加部分的 git 子模块。
git submodule update --init
说明#
现在您已准备好生成文档，请键入：
spin docs
这将从源代码构建 NumPy（如果您尚未构建），并运行 Sphinx 来构建 html 文档。如果一切顺利，这将在 /doc 目录中生成一个 build/html 子目录，其中包含已构建的文档。
在 https://numpy.com.cn/doc 上分发的 NumPy 文档（html 和 pdf 格式）也是使用 make dist 构建的。有关如何更新 https://numpy.com.cn/doc 的详细信息，请参阅 HOWTO RELEASE。