使用 Sphinx 翻譯說明文件¶
Sphinx 是用來建立漂亮文件的工具。它使用了簡單的 reStructuredText 語法，並以多種格式輸出。如果要找個範例，那麼本文件也是用它來建置的。使用 Sphinx 的非常有用的夥伴是 Read the Docs 服務，它會免費建置並發佈您的文件。
本文不著重說明如何撰寫說明文件；若需要相關指引，請依照 Sphinx 網站的說明操作。完成說明文件後，翻譯相當容易，因為 Sphinx 本身支援此功能，Internationalization 也有完整說明。只需要設定少數指令，並呼叫 sphinx-intl 工具。
若使用 Read the Docs 服務，可以開始在 Read the Docs 上建置翻譯後的說明文件。其 Localization and Internationalization 涵蓋幾乎所有必要步驟，包括建立另一個專案、設定語言，以及從主要專案連結該專案作為翻譯。
接下來只需翻譯說明檔案內容。Sphinx 會為每個目錄或頂層檔案產生 PO 檔案，因此可能產生大量待翻譯檔案（取決於 gettext_compact 設定）。您可以先將 index.po 匯入 Weblate 作為初始元件，再設定 元件探索 附加元件，自動探索其他所有元件。
|
|
|
|
|
|
gettext PO 檔案 |
|
|
用來比對出翻譯檔案的正規表達式 |
|
自訂元件名稱 |
|
定義新翻譯的基礎檔案 |
|
提示
您希望 Sphinx 產生只是單一的 PO 檔案嗎？從 Sphinx 3.3.0 開始可以達成，使用：
gettext_compact = "docs"
有數個說明文件專案使用此方式進行翻譯：