构建 NumPy API 和参考文档#
如果您只想获取文档，请注意预构建版本可在以下网址找到：
以多种不同格式提供。
开发环境#
在继续之前，需要注意的是文档是使用 make 工具构建的，该工具在 Windows 上并非原生可用。macOS 或 Linux 用户可以直接跳转到先决条件。建议 Windows 用户在 GitHub Codespaces（参见推荐的开发设置）或适用于 Linux 的 Windows 子系统 (WSL) 上设置他们的开发环境。WSL 是进行持久化本地设置的良好选择。
先决条件#
构建 NumPy 文档和 API 参考需要以下内容
NumPy#
由于大部分主文档是通过 import numpy 和检查文档字符串（docstrings）从 NumPy 获取的，因此您需要首先构建并安装它，以便导入正确的版本。每次获取存储库的最新版本之前，都需要重新构建并重新安装 NumPy，然后才能生成文档。这确保了 NumPy 版本与 Git 存储库版本保持同步。
请注意，您可以例如将 NumPy 安装到临时位置并适当设置 PYTHONPATH 环境变量。另外，如果使用 Python 虚拟环境（例如通过 conda、virtualenv 或 venv 模块），建议将 NumPy 安装到一个新的虚拟环境中。
依赖项#
构建 NumPy 文档所需的所有依赖项（除了 Doxygen）可以通过以下方式安装：
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，则可以通过您的发行版包管理器进行安装。
注意
尝试安装比 1.8.10 更新的 Doxygen 版本，否则在构建过程中可能会收到一些警告。
子模块#
如果您通过 Git 获取了 NumPy，请同时获取包含构建文档所需额外部分的 Git 子模块
git submodule update --init
指令#
现在您可以生成文档了，请键入
spin docs
这将（如果您尚未构建）从源代码构建 NumPy，并运行 Sphinx 来构建 html 文档。如果一切顺利，这将在 /doc 目录下生成一个名为 build/html 的子目录，其中包含已构建的文档。
在 https://numpy.com.cn/doc 上分发的 HTML 和 PDF 格式的 NumPy 文档也是通过 make dist 构建的。有关如何更新 https://numpy.com.cn/doc 的详细信息，请参阅 HOWTO RELEASE。