建置 NumPy API 與參考文檔#
如果您只想取得文件，請注意預先建置的版本可以在以下位置找到
以幾種不同的格式提供。
開發環境#
在繼續之前，應注意文件是使用 make 工具建置的，該工具在 Windows 上不是原生可用的。MacOS 或 Linux 使用者可以跳到 先決條件。建議 Windows 使用者在 GitHub Codespaces 上設定其開發環境（請參閱 建議的開發設定）或 Windows Subsystem for Linux (WSL)。WSL 是持久性本地設定的良好選擇。
先決條件#
建置 NumPy 文件和 API 參考文檔需要以下條件
NumPy#
由於主要文件的大部分是通過 import numpy 從 NumPy 取得並檢查 docstrings，因此您需要先 建置 並安裝它，以便導入正確的版本。每次在產生文件之前，當您提取儲存庫的最新版本時，都必須重新建置並重新安裝 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，這將從原始碼建置 NumPy，並運行 Sphinx 以建置 html 文件。如果一切順利，這將在 /doc 目錄中產生一個 build/html 子目錄，其中包含已建置的文件。
以 html 和 pdf 格式分發在 https://numpy.dev.org.tw/doc 的 NumPy 文件也是使用 make dist 建置的。有關如何更新 https://numpy.dev.org.tw/doc 的詳細資訊，請參閱 HOWTO RELEASE。