Sphinx 文檔工具

Sphinx簡單來說，是一個文檔生成工具，用于把reStructuredText 格式的源文件生成諸如HTML, PDF, LaTex一類的格式。編輯者無須親自處理文本的格式, 程序會自動根據(jù)源文件里的設(shè)置產(chǎn)生格式, 以及自動生成章節(jié)鏈接等工作。

和 DocBook一樣，Sphinx可以看做是一個把文本格式處理和文字編輯分開的工具。舉個例子來說吧，大家一定都曾有過上學(xué)時用Word痛苦地修改論文 的經(jīng)驗（沒辦法，在中國LaTex太小眾），其中Word里面千奇百怪的可見或不可見的格式符、控制符一定玩弄了大家很久。而類似DocBook或 reStructuredText 一類的格式則完全采用文本文件來記錄文字格式，各種格式控制字符完全可見，不會出現(xiàn)如Word里某個隱藏在段落末尾的莫名控制符導(dǎo)致文章之后的某些部分完 全亂掉，而完全找不到這個控制符的情況了。同時，完全采用純文本文件進(jìn)行記錄，使得使用版本控制軟件對編輯工作進(jìn)行全程追蹤和記錄成為了可能。而最終通過 文本的源文件生成具有格式和樣式的文本則完全是程序所進(jìn)行的工作，避免了一切出錯的可能。

使用Sphinx的項目有很多，著名的包括 Python , Django 的文檔，全部是使用Sphinx 生成的。