构建 NumPy API 和参考文档#
如果您只想获取文档，请注意预构建版本可以在以下位置找到：
提供多种不同格式。
开发环境#
在继续之前，需要注意的是文档是使用make工具构建的，该工具在 Windows 上并非原生可用。 MacOS 或 Linux 用户可以跳至先决条件。 建议 Windows 用户在 GitHub Codespaces 上设置其开发环境（请参见推荐的开发设置）或Windows 子系统 Linux (WSL)。WSL 是持久本地设置的不错选择。
先决条件#
构建 NumPy 文档和 API 参考需要以下内容：
NumPy#
由于大部分主要文档是通过import numpy从 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 文档中呈现文档字符串。SciPy已安装，因为文档的某些部分需要 SciPy 函数。
要安装Doxygen，请查看官方下载和安装页面，或者如果您使用的是 Linux，则可以通过您的发行版包管理器安装它。
注意
尝试安装较新版本的Doxygen > 1.8.10，否则您可能会在构建过程中收到一些警告。
子模块#
如果您通过 git 获取了 NumPy，请同时获取包含构建文档所需的其他部分的 git 子模块。
git submodule update --init
说明#
现在您可以生成文档了，所以请编写：
spin docs
如果尚未构建 NumPy，这将从源代码构建 NumPy，并运行 Sphinx 来构建html文档。如果一切顺利，这将在/doc目录中生成一个build/html子目录，其中包含已构建的文档。
在https://numpy.com.cn/doc以 html 和 pdf 格式分发的 NumPy 文档也是使用make dist构建的。有关如何更新https://numpy.com.cn/doc的详细信息，请参见HOWTO RELEASE。