Sphinx (文檔生成器)
Sphinx是Python社區編寫和使用的文檔生成器。它是用Python編寫的，也可以在其他環境中使用。
 | |
| 開發者 | Georg Brandl |
|---|---|
| 首次發佈 | 2008年3月21日 |
| 當前版本 | 1.8.1[1]（2018年9月22日） |
| 預覽版本 | 2.0.0 |
| 原始碼庫 | |
| 程式語言 | Python |
| 作業系統 | 跨平台 |
| 類型 | 文檔生成器 |
| 許可協議 | BSD許可證 |
| 網站 | sphinx-doc |
目的和功能
編輯Sphinx將reStructuredText文件轉換為HTML網站和其他格式，包括PDF、EPUB、Texinfo和man。
reStructuredText是可擴展的，Sphinx通過許多擴展來利用其可擴展性 — 用於從原始碼自動生成文檔、編寫數學符號或突出顯示原始碼等。
歷史和使用
編輯2008年3月21日，發佈了第一個公共版本0.1.61611。[2]它是為Python項目的文檔開發的，也已得到了廣泛的應用。[3]
自2008年Sphinx被引入以來，已經被許多其他重要的Python項目採用，包括Bazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django和Pylons。它還用於Blender用戶手冊[4]和Python API文檔。[5]
2010年，Eric Holscher宣佈[6]創建Read the Docs項目，作為使軟件文檔維護更容易的努力的一部分。Read the Docs可以在每次提交之後自動構建和上傳Sphinx文檔。
Linux內核
編輯Linux內核的文檔子系統在2016年發生了變化。從4.7開發周期開始，文檔開始切換到使用Sphinx。[7]
- LCA2016 演講：作為內核文檔維護者的我學到了什麼（YouTube上的What I've learned as the kernel docs maintainer）
- LCA2017 演講：內核文檔：現狀及未來（YouTube上的Kernel documentation: what we have and where it's going）
另請參閱
編輯
參考文獻
編輯- ^ Changes in Sphinx. [2018-12-07]. （原始內容存檔於2015-12-26）.
- ^ Sphinx is released! » And now for something completely Pythonic.... And now for something completely Pythonic... Georg Brandl. [2011-04-03]. （原始內容存檔於2012-03-22）.
- ^ About these documents — Python v2.7.1 documentation. Python documentation. Python Software Foundation. [2011-04-03]. （原始內容存檔於2012-10-25）.
- ^ Blender User Manual. Blender Wiki. Blender Foundation. [2018-12-07]. （原始內容存檔於2016-08-26）.
- ^ Dev:2.5/Py/API/Generating API Reference - BlenderWiki!. Blender Foundation. Blender Foundation. [2018-12-07]. （原始內容存檔於2013-01-26）.
- ^ Announcing Read The Docs. Python Software Foundation News. Eric Holscher. [2015-02-15]. （原始內容存檔於2013-01-26）.
- ^ Kernel documentation update. LWN.net. 2016-11-02 [2018-12-07]. （原始內容存檔於2018-11-23）.
外部連結
編輯- Sphinx文檔生成器項目網站（頁面存檔備份，存於互聯網檔案館）
- Read the Docs（頁面存檔備份，存於互聯網檔案館） 提供Sphinx支持的大型協作文檔主機