多語系 Sphinx 與 Python 官方文件中文化

語言

中文演講/中文投影片

分類

Python Core(語言本身、標準函式庫…)

Python 難易度

中階

投影片連結

https://blog.liang2.tw/2016Talk-PyDoc-TW

摘要

Python 除了以易讀、易用、易學之外,它也有非常完整的官方文件。然而,因為英文內容,初次使用它時倍感困難,於是有了中文化翻譯計畫。目前翻譯的結果可見 https://docs.python.org.tw/3/ 。本演講將分享本翻譯計畫的整體規劃,以及相關的技術細節,如:Sphinx 文件的多國語言、Transifex 翻譯協作平台整合、文件更新的工作排程等主題。

說明

Python 官方文件包含了從零開始的 tutorial、標準函式庫介紹、語法定義、以及 CPython C API 等,但在許多初學者的回饋中,發現因為英文,加上文件龐大複雜,很難上手,尤其是對新手最有幫助的 tutorial,經常直接被跳過,十分可惜,因此有了[中文化翻譯計畫][pydoctw]。 為了讓更多人能直接加入翻譯,本計畫設計只要登入 [Transifex] 即可以開始翻譯,不需理解 [Sphinx] 文件系統生成網頁與結合 gettext 多語系的過程。同時翻譯者也能在不用自己編譯的情況下,即時更新線上翻譯的結果,系統也會定期將新的翻譯加入[版本控制][cpython-tw]中,離線也能使用翻譯的結果。 本演講將分為三大部份: 1. Sphinx 文件結合 [gettext] 多語系的架構。 2. 目前 Python 官方文件的架構。 3. 官方文件翻譯計畫。 前二部份將探討技術問題。由於許多 Python 套件的文件皆使用 Sphinx 生成說明文件,這套多語系的翻譯流程也能適用在其他專案。第三部份則將著重在翻譯,分享翻譯的心得以及遇上的狀況。希望透過這次方享,能聚集更多人加入翻譯的行列。 [pydoctw]: https://github.com/python-doc-tw/python-doc-tw [cpython-tw]: https://github.com/python-doc-tw/cpython-tw [Transifex]: https://www.transifex.com/ [Sphinx]: http://www.sphinx-doc.org/en/stable/ [gettext]: https://zh.wikipedia.org/wiki/Gettext

Liang-Bo Wang

亮亮 (or liang2) is a current master student in Bioinformatics at NTU. He will become a PhD student at WUSTL by fall this year. Aside from academics, liang2 attends and speaks in Python and R open source communities, including Taipei.py and MLDM Monday. He is also the Program Chair of PyCon Taiwan 2016.

His blog liang2.tw dumps random notes at times. However, the update frequency is quite low these days, for he has been working very hard to graduate. He doesn't even have time to complete the about page on his blog.