建築文件¶
在對 BeeWare 的文件進行任何變更之前，確認您可以建立現有的文件是很有幫助的。
在建立文件之前，請先設定好開發環境。
您 ** 必須** 在路徑上安裝 Python 3.13 譯器，並且可以使用 (也就是說， python3.13 必須啟動 Python 3.13 譯器)。
BeeWare 使用 tox 建立文件。以下的 tox 指令必須從與 tox.ini 檔相同的位置執行，也就是專案的根目錄。
即時文件預覽¶
為了支援文件的快速編輯，BeeWare 具有「即時預覽」模式。
即時預覽將伴隨警告訊息進行建構！
Live serve 可供您迭代文件更新。在更新的過程中，您可能會引入標記問題。被視為「警告」的問題會導致標準建立失敗，然而，即時服務的設定會在控制台輸出中顯示警告，同時繼續建立。這允許您迭代，而不需要重新啟動即時預覽。
警告」與「錯誤」不同。如果您引入了被視為 ERROR 的問題，即時服務就會失敗，並需要重新啟動。在 WARNING 問題解決之前，它不會再次啟動。
啟動即時伺服器：
(venv) $ tox -e docs-live
(venv) $ tox -e docs-live
(venv) C:\...>tox -e docs-live
這將會建立文件、啟動 Web 伺服器以提供文件，並觀察檔案系統對文件來源的任何變更。
伺服器啟動後，您會在主控台輸出中看到類似以下的內容：
INFO - [11:18:51] Serving on http://127.0.0.1:8000/
開啟瀏覽器，並導航至所提供的 URL。現在您可以開始迭代文件。如果偵測到變更，文件將會重建，任何檢視修改後頁面的瀏覽器都會自動重新整理。
docs-live` 是一個初步的步驟
執行 docs-live 來使用 Live 伺服器是用來進行初始迭代的。在提交拉取請求之前，您應該 ** 執行本地建立。
本地建置¶
一旦完成迭代，您就需要在本地建立文件。如果有任何標記問題，這個建立過程會失敗。這可讓您捕捉任何您在 Live 伺服器上可能遺漏的問題。
產生本地建立¶
若要產生本地建立：
(venv) $ tox -e docs
(venv) $ tox -e docs
(venv) C:\...>tox -e docs
此建立的輸出將會在專案根目錄的 _build 目錄中。
產生本地翻譯的建立檔¶
BeeWare 的說明文件已翻譯為多種語言。英文文件的更新有可能導致其他語言版本的問題。在提交拉取請求之前，請務必確認所有的建立版本都正常運作。
要產生所有可用翻譯的建立檔：
(venv) $ tox -e docs-all
(venv) $ tox -e docs-all
(venv) C:\...>tox -e docs-all
每種語言的建立輸出會在相關的 _build/html/<languagecode> 目錄中，其中 <languagecode> 是與特定語言相關的 2
個或 5 個字元的語言代碼 (例如 fr 代表法文、it 代表義大利文等)。
如果您發現單一建立有問題，您可以執行 tox -e docs-<languagecode> 來分別執行該單獨建立。例如，若要只建立法文文件，請執行：
(venv) $ tox -e docs-fr
(venv) $ tox -e docs-fr
(venv) C:\...>tox -e docs-fr
單一語言建立的輸出將會在 _build 目錄中。
文件整理¶
建立過程會找出 Markdown 的問題，但 BeeWare 會執行一些額外的樣式與格式檢查，稱為「linting」。執行 lint 檢查：
(venv) $ tox -e docs-lint
(venv) $ tox -e docs-lint
(venv) C:\...>tox -e docs-lint
這將驗證文件不包含：
- 死超連結
- 拼字錯誤
如果一個單字的有效拼法被識別為拼錯，則將該單字加入 docs/spelling_wordlist
中的清單。這將會把該單字加入拼字檢查器的字典中。加入此清單時，請記住：
- 我們偏好美式拼法，但對於程式特定的口語（例如「apps」）和名詞的動詞（例如「scrollable」）則有一些自由度。
- 任何對產品名稱的引用都應該使用該產品名稱的首字母大寫。(例如，"macOS"、"GTK"、"pytest"、"Pygame"、"PyScript"）。
- 如果一個詞語是 「作為代碼 」使用的，那麼它應該被引用為字面意義（
like this），而不是被添加到字典中。
成功建立文件後，您便準備好[撰寫文件]了。