Sphinx

使用者

• 使用 Sphinx 的專案們

例如：

• NumPy

Linux kernel

介紹

Linux kernel 在 2016 年把文件從原本的 DocBook 轉換到 Sphinx 上， 也因此在 Linux 4.8-rc1 中有超過 20% 的 patch 在文件上，

• How to write kernel documentation

• Kernel documentation with Sphinx, part 1: how we got here

• Kernel documentation with Sphinx, part 2: how it works

• Kernel documentation update

• conf.py 設定檔

• Makefile.sphinx

• Linux kernel Sphinx extensions folder

kerneldoc

kerneldoc 可以從 Kernel 程式碼內爬出特定格式的註解來生成文件。

rstFlatTable

rstFlatTable 實做 rstFlatTable directive， 輔助 table 的撰寫。

kernel_include

kernel_include 實做 kernel-include directive， 用於取代內建的 include 功能， 讓 include 更適用於 Kernel 的程式碼。

cdomain

Sphinx 的 Domains 是支援不同程式語言的方式， 雖然 Sphinx 內建就有 C Domain， 但是 Linux kernel 內的 cdomain 實做了替換 Sphinx 內建的 C Domain 的 Extension， 做了一些客製化。

常見 Sphinx Extensions

參考