Sphinx (文檔生成器)

提示：此條目的主題不是CMU Sphinx或Sphinx (搜尋引擎)。

Sphinx是Python社區編寫和使用的文檔生成器。它是用Python編寫的，也可以在其他環境中使用。

Sphinx

開發者	Georg Brandl
首次發布	2008年3月21日 (2008-03-21)
當前版本	1.8.1[1]（2018年9月22日，​6年前​（2018-09-22））
預覽版本	2.0.0
原始碼庫	github.com/sphinx-doc/sphinx
程式語言	Python
作業系統	跨平台
類型	文檔生成器
許可協議	BSD許可證
網站	sphinx-doc.org

目的和功能

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）

另請參閱

• 自由軟體主題

• 文檔生成器的比較（英語：Comparison_of_documentation_generators）