Up to date
This page is up to date for Godot 4.2
.
If you still find outdated information, please open an issue.
建置 Mono 執行環境¶
本頁面描述使用 Sphinx 文件引擎建構本地 Godot 手冊的方法。你可以用它來獲得本地的 HTML 檔以及諸如 PDF、EPUB、LaTeX 形式的文件。
在開始之前,請確保你已完成以下步驟:
make (除非你在使用Windows系統)
備註
Python 3 應該帶有 pip3
命令。 您可能需要輸入 python3 -m pip
(Unix)或 py -m pip
(Windows)而不是 pip3
。 如果兩種方法都失敗了,\\`請確保您已安裝 pip3 <https://pip.pypa.io/en/stable/installation/>`__\\。
(可選) 設定虛擬環境。 虛擬環境可防止
requirements.txt
中的 Python 包與系統上安裝的其他 Python 包之間的潛在衝突。設定自定建置環境
py -m venv godot-docs-venv
python3 -m venv godot-docs-venv
設定自定建置環境
godot-docs-venv\Scripts\activate.bat
source godot-docs-venv/bin/activate
(可選) 更新預先安裝的套裝軟體:
py -m pip install --upgrade pip setuptools
pip3 install --upgrade pip setuptools
克隆(clone)文件倉庫:
git clone https://github.com/godotengine/godot-docs.git
將目錄切換到文件倉庫:
cd godot-docs
安裝套件
pip3 install -r requirements.txt
內建主題編輯器。
make html
備註
在 Windows 上,該命令將運作
make.bat
而不是 GNU Make(或其他替代方案)。或者你也可以手動呼叫 sphinx-build 程式來建構文件:
sphinx-build -b html ./ _build/html
因為 classes/
資料夾裡包含了上百個檔,所以編譯的過程會花上一些時間。詳見 屬性目標中的效能提示。
完成後就可以在網頁瀏覽器裡打開 _build/html/index.html
查看文件了。
設定為錯誤的警告¶
若要從 GitHub 上 Clone 你的 Fork,請使用下列指令:
make SPHINXBUILD=~/.local/bin/sphinx-build html
如果你遇到了 MemoryError
或者 EOFError
,可以把 classes/
資料夾刪除然後重新執行 make
。這樣會在最終的 HTML 文件中刪除類參考文件,其它內容還是一致的。
重要
一旦刪除 classes/
資料夾,在處理 Pull Request(拉取請求)時請勿使用 git add .
,否則整個 classes/
資料夾的刪除都會記錄進你的提交之中。詳情見 #3157 <https://github.com/godotengine/godot-docs/issues/3157>。
屬性目標中的效能提示¶
手動使用¶
磁片交換會拖慢文件建構的速度,關閉後需要至少 8 GB 的記憶體。如果你有至少 16 GB 的記憶體,可以這樣加速編譯:
set SPHINXOPTS=-j2 && make html
make html SPHINXOPTS=-j2
您可以使用 -j auto
來使用所有可用的 CPU 執行緒,但是如果您有很多 CPU 執行緒,這可能會使用大量 RAM。 例如,在具有 32 個 CPU 執行緒的系統上, -j auto
(此處對應於 -j 32
)僅 Sphinx 就需要 20+ GB 的 RAM。
提供檔案¶
你也可以指定需要建構的檔列表,大幅加速編譯:
make FILELIST='classes/class_node.rst classes/class_resource.rst' html