複製鏈接
請複製以下鏈接發送給好友

Sphinx

(一種文檔生成工具)

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