Sphinx是一個工具，它能夠輕易地創建智慧和優雅的文檔，出自Georg Brandl之手，在BSD許可證下授權。它能夠把一組 reStructuredText 格式的檔案轉換成各種輸出格式，而且自動地生成交叉引用，生成目錄等。也就是說，如果有一個目錄，裡面包含一堆reST格式的文檔（可能子目錄裡面也同樣存在reST格式的文檔），Sphinx能夠生成一個漂亮的組織結構以及便於瀏覽和導航的HTML 檔案（這些檔案在其他的資料夾中）。當然對於同樣的來源檔案（reST格式），它也能夠生成一個能夠被編譯（生成）PDF版本的LaTeX格式的檔案。
基本介紹
- 中文名：Sphinx
- 類別：一個工具
- 自動生成目錄：通用索引以及語言模組的目錄
- 代碼高亮：代碼自動高亮
特性
- 多種輸出格式： 超文本標記語言 (包括Windows HTML幫助)，LaTeX (可列印的PDF版本)，手冊頁，純文本
- 豐富的交叉引用： 語義標記以及針對函式，類，引用，辭彙表（術語）和相似的信息塊的自動連結
- 層次結構： 簡單的文本樹定義，就能自動地連結到同層（兄弟姐妹）、上一層（父母）以及下一層（子女）的文本位置
- 自動生成目錄： 通用索引以及語言模組的目錄
- 代碼高亮： 代碼自動高亮，通過使用 Pygments
- 擴展功能： 自動測試的代碼片段，包括從Python模組（API文檔）的文檔字元串
