Sphinx

當首次創建的，它的主要目的是作為的Python 自己的代碼文檔生成。
自那時以來，該項目已達到了世界發展的崇拜狀態，是一個最有參考的影響，在各地的大多數自動文檔生成器，無論語言。
如今，除了剛才的Python，獅身人面像，也可以使用C和C ++代碼。

什麼在此版本中是新的

• 將便利指令和角色到C ++域：指令``CPP：var``作為別名``CPP：member``，角色``：CPP：var``作為別名``：CPP：成員``和`角色為any`交叉引用到任何C ++ declaraction。
• 的：confval：​​`現在source_suffix`配置值可以是多個後綴的列表
。
• 將通過源後綴與指定源解析器的能力：confval：​​`source_parsers`配置值
• 在一個新的建設者，AppleHelpBuilder，已經加入了蘋果公司建立圖書的幫助。

在什麼版本的新 1.2.3 / 1.3b3：

• 新增``sphinx.version_info``元組的獅身人面像的版本綱領性檢查。

在什麼版本1.1.3新是

• 修正了與一些設置：confval：​​`modindex_common_prefix`
• 修正處理``-D``和``-A``選擇了Python 3。
• 識別和警告，而不是運行到遞歸誤差有關循環toctrees。
• 恢復兼容docutils的樹幹。
• 固定HtmlHelp的索引條目鏈接了。
• 修正inheritance_diagram上建宏提高屬性的錯誤。

把意見或獨行條款時，在詞彙表
• 修正了崩潰。
• 固定的HTML幫助語言/編碼映射獅身人面像所有支持的語言。

在什麼版本1.1是新的

• 功能的加入：
• 新增的Python 3.x的支持。
• 新的建設者和子系統。
• 在不兼容的變化：
• 的：RST：DIR：`PY：module`指令不輸出它的``platform``選項的值了。 （這是唯一的指令做輸出，因此頗不一致。）
• 刪除了舊版本的相關支持。
• 新的語言環境：
• 新增瑞典語語言環境。
• 補充伊朗的語言環境。
• 添加拉脫維亞語言環境。
• 新增尼泊爾語言環境。
• 添加韓文語言環境。
• 添加愛沙尼亞的語言環境。

在什麼版本1.0.8新是

• 修正回溯在自動摘要代AttributeErrors。
• 修正了``abbr``角色時的縮寫具有換行符在裡面。
• 修正的鏈接，搜索與自定義對象類型的結果。

在報告關於未定義的引用警告
• 修正行號。
• 修正C ++數組定義和模板參數未鍵入名稱。
• 允許在節頭腳註LaTeX的輸出。
• 允許關鍵字通過intersphinx鏈接。
• 允許在生產列表標記名稱的Unicode字符。
• 將虛擬遊客文本和人graphviz的節點。
• 修正圖像文件的複製錯誤。

多個簽名的C ++域
• 修正解析。
• 查找源文件時，忽略Emacs的鎖文件。
• 允許.pyw擴展在車博士導入的模塊。
• 使用``$在快速入門生成生成文件（MAKE）``。
• 請在瀏覽器側邊欄搜索框的寬度一致。
• 修正的HTML輸出中心數字間距。
• 在打印時，它們編碼安全信息SphinxError在sys.stderr。
• 修正LaTeX的輸出誤差與不部分的文檔，但鏈接的目標。
• 在正確對待內置的方法描述為在車博士的方法。
• 停止的monkeypatching Python的textwrap模塊。
• Viewcode現在有非ASCII編碼的源文件可以正常工作。
• 在尊重PY中的``noindex``標誌選項：模塊指令

RST：DIR：
• 在其中不存在的線，當修復IndexErrors。`literalinclude`
• 在尊重自定義函數/方法的參數字符串分隔。
• 修正JS不兼容與jQuery＆GT;。= 1.5
• 寫的HTMLHelp .hhk文件時修復完成雙重編碼。
• 請不要在解析字面塊適用SmartyPants。
• 在C ++領域現在支持數組的定義。

在什麼版本1.0.6新是

• 修正回溯的空交叉引用目標的Python域。
• 修正文字塊顯示屏上的問題的Chrome瀏覽器。
• 支持在總指數和詞彙的排序重音字符範圍有限。
• 嘗試解碼``-D``和``-A``命令行參數的語言環境的首選編碼。
• 注意：confval：​​`locale_dirs`找JS翻譯文件時
• 將特殊的代碼更好的支持，在建設者的LaTeX文檔日本人
• 的＃77回歸：如果沒有與``只給出了一個參數：參數：``標記，子彈名單現在又​​抑制
• 修正了在某些情況下，LaTeX輸出缺段中斷。
• 發出``車博士 - 過程 - docstring``事件即使對象而不文檔字符串，以便它可以添加內容。
• 在LaTeX的建設者，不僅文字塊需要不同的表處理，而且還不少其他類似列表的塊元素。
• 修正回溯在viewcode擴展Python對象沒有一個有效的簽名。
• 修正行號的怪reportings從車博士 - 包括文檔字符串，因為這取決於docutils的版本不同的行為所產生的警告。
• 若干修正到C ++域。

在什麼版本1.0.5新是

• 將通過docutils的0.7對準的圖像和數字所需的CSS樣式。
• 在Makefile中乳膠輸出生成，不刪除乾淨的PDF文件;他們可能需要的圖像。
• 線路塊生成修復LaTeX的輸出。
• 允許``.pyw``作為源文件的擴展名。

在什麼版本1.0.4是新的

• 開啟intersphinx庫存在Windows二進制模式，因為第2版中包含的zlib壓縮數據。
• 允許給非本地的URI的JavaScript文件，如在JSMath擴展。
• 修正回溯時``intersphinx_mapping``是空的。

在什麼版本1.0.3新是

• 修正與內部的鏈接從docutils的表中，今後內容的外部鏈接的區別。
• 修正了``maxdepth``選項為``toctree（）``和`使用時可調用模板坍塌`= True``。
• 修正崩潰的解析括號包含在字符串的Python參數列表。
• LaTeX的建設與文檔沒有字幕的數字時，修復回歸。
• 修正的繼承圖的類未picklable。
• 在實施分開背景顏色側邊欄折疊按鈕，使其更容易看到的。
• 修正的小蟲子佈局的幾個內置的主題。

在什麼版本1.0.2是新的

• 修正交叉引用到所添加的對象類型：FUNC：`〜.Sphinx.add_object_type` API函數
• 修正文檔字段類型不同的指令類型的操作。
• 允許打破長的簽名，與間隙轉義換行符繼續。
• 修正（因為一個命名空間衝突與Pygments風格）C域引用不必要的造型。
• 允許引用政治公眾人物和RFC中有明確的錨。
• 修正LaTeX的參考數字。
• 當執行非精確搜索，僅匹配給定類型的對象。
• 申請Python的參考指標非精確搜索與``.name``的模塊了。
• 在複製時，在一個信息字段列表參數修正崩潰。
• 修正設定的默認角色之一的``oldcmarkup``擴展提供。
• 在安裝JSON-PY修復時崩潰，它提供了一個``json``模塊，但不兼容於simplejson。
• 修正的intersphinx目標命名操作。
• 修正去除``的！``所有交叉引用的角色。

在什麼版本1.0.1是新的

• 修正休息域對象生成的目標名稱;它們不在相同的命名空間。
• 將孟加拉語。
• 修正了解析JavaScript對象名稱的錯誤。
• 修正建設有SingleHTMLBuilder時，有沒有toctree。
• 修正顯示名稱與明確的目標掛鉤由intersphinx對象。
• 修正帶建設的JSON生成器。
• 修正hyperrefs對象的描述LaTeX的。

什麼版本1.0是新的

• 常規：
• 添加了一個“挑剔”模式，發射所有失踪引用警告。選項：`-n`命令行開關或：confval：​​這是由激活。`nitpicky`配置值
• 在快速啟動加``latexpdf``目標Makefile文件。
• 標記：
• 的：RST：角色：`menuselection`和：RST：角色：`guilabel`角色現在支持符號加速器
• 在新的更緊湊的DOC場語法是目前公認：``：參數類型名稱：description``
• 新增``製表width``選項：RST：DIR：`literalinclude`指令
• 新增``titlesonly``選項：RST：DIR：`toctree`指令
• 添加了``prepend``和``append``選擇到：RST：DIR：`literalinclude`指令
• 所有文檔信息元數據現在放入文檔元數據，而不僅僅是作家。
• 的：RST：角色：`ref`作用，現在還可以通過標題引用表
。
• 的：RST：DIR：`include`指令現在支持絕對路徑，它被解釋為相對於源目錄
• 在Python的領域，如``參考資料：FUNC：`.name```現在看起來與任何前綴，如果沒有直接找到匹配匹配的名字
• 配置：
• 新增：confval：​​`rst_prolog`配置值
• 新增：confval：​​`html_secnumber_suffix`配置值，以控制部分編號格式為：
• 新增：confval：​​`html_compact_lists`配置值來控制docutils的“緊湊列表功能
• 的：confval：​​`html_sidebars`配置值現在可以包含模式作為鍵和值可以是列出了明確選擇其中的側邊欄模板應該呈現。這意味著，內建的側邊欄內容可以只選擇性地包括在內。
• ：confval：​​`html_static_path`現在可以包含單個文件條目
• 在新的通用配置值：confval：​​`exclude_patterns`使老：confval：​​`unused_docs`，：confval：​​`exclude_trees`和：confval：​​`exclude_dirnames`過時
• 新增：confval：​​`html_output_encoding`配置值
• 添加了：confval：​​`latex_docclass`配置價值，並提出了“twoside”的DocumentClass選項重寫的“oneside”
。
• 添加了：confval：​​`trim_doctest_flags`配置價值，這是真正的默認
• 新增：confval：​​`html_show_copyright`配置值
• 新增：confval：​​`latex_show_pagerefs`和：confval：​​`latex_show_urls`配置值
• 的行為：confval：​​`html_file_suffix`略有變化：空字符串現在的意思是“沒有後綴”，而不是“默認後綴”，使用``None``為“默認後綴”
。
• 新建設者：
• 添加了建設者的EPUB格式。
• 添加了一個建設者手冊頁。
• 添加單個文件的HTML生成器。
• HTML輸出：
• 內聯的角色現在得到一個CSS類與他們的名字，讓樣式自定義它們的外觀。域特定的角色得到兩班，``domain``和``域rolename``。
• 引用現在得到的類``internal``如果他們內部的整個項目，而不是內部的當前頁面。
• 外部引用可以與新的``externalrefs``主題為默認的主題選項不同的樣式。
• 在默認的主題，側邊欄可以實驗現在可以使用新的``collapsiblesidebar``主題選項時可折疊。
• Toctrees現在裹著``div``帶班``toctree-wrapper``在HTML輸出標記。
• 的：數據：`toctree`調用模板現在有一個``maxdepth``關鍵字參數來控制生成的樹的深度
• 的：數據：`toctree`調用模板現在接受``titles_only``關鍵字參數
• 新增``htmltitle``塊佈局模板。
• 在JavaScript的搜索，讓搜索對象名稱包括模塊名稱，如``sys.argv``。
• 添加新的主題``haiku``，靈感來自俳句操作系統用戶指南。
• 添加新的主題``nature``。
• 添加新的主題``agogo``，由安迪阿爾布雷希創建。
• 添加新的主題``scrolls``，由阿明Ronacher創建。
• 添加了``visitedlinkcolor``主題選項默認主題。
• 在搜索頁面的改進響應異步通過加載thesearch指數。
• 擴展API：
• 補充：事件：`HTML - 收集 - pages`
• 新增：confval：​​`needs_sphinx`配置值和：甲：`〜sphinx.application.Sphinx.require_sphinx`應用程序API方法
• 補充：甲：`〜sphinx.application.Sphinx.add_stylesheet`應用程序API方法
• 擴展：
• 添加了：MOD：`〜sphinx.ext.viewcode`擴展
。
• 添加了：MOD：`〜sphinx.ext.extlinks`擴展
。
• 增加了對車博士成員源排序支持，``autodoc_member_order ='bysource'``。
• 新增：confval：​​`autodoc_default_flags`配置值，可用於選擇默認的標誌車博士所有指令
• 添加一種方式intersphinx指在其他項目命名的標籤，並指定要鏈接到項目中。
• 車博士現在可以記錄例如在``__init__``方法屬性分配。
• 很多改進和修正至：MOD：`〜sphinx.ext.autosummary`擴展，這要歸功於保利維爾塔寧
• 的：MOD：`〜sphinx.ext.graphviz`擴展現在可以輸出SVG，而不是PNG圖像，由co​​nfval控制：`graphviz_output_format`配置值
• 新增``alt``選項：RST：DIR：`graphviz`擴展指令
• 新增``exclude``參數：FUNC：`.autodoc.between`
• 翻譯：
• 新增 - 克羅地亞語翻譯，感謝博揚Mihelac。
• 新增土耳其語翻譯，感謝的Firat厄茲居爾。
• 新增加泰羅尼亞語翻譯，這要歸功於保羅·費爾南德斯。
• 新增簡體中國的翻譯。
• 新增丹麥的翻譯，感謝Hjorth拉森。
• 新增 - 立陶宛語翻譯，感謝Dalius Dobravolskas。

什麼版本1.0b1是新的

• 支持域名已被添加。域是指令，所有描述對象屬於一起，例如角色的集合編程語言元素。提供了一些內置的域： - Python的 - C - C ++ - 的JavaScript - 新結構化
• 舊標記定義和連接到C指令將不會在不激活的``oldcmarkup``延長工作了。
• 刪除了舊版本的相關支持。
• 刪除過時的元素。

在什麼版本0.6.5新是

• 在車博士，修正遺漏的某些模塊成員使用文檔註釋明確記載。
• 修正側邊欄滾動條的裁剪與``的默認主題stickysidebar``選項。
• 始終生成UNIX換行符在快速入門的Makefile。
• 修正了``-C`` Windows下運行。
• 在車博士，允許自定義對象，其中內置的機制失效的簽名。
• 修正輸出與初始值在LaTeX的枚舉列表。
• 請了``啟動after``和``最終before``選項給``literalinclude``指令正常工作，如果不一起使用。
• 修正鏈接產生的LaTeX的建設者。

在什麼版本0.6.4新是

• 改進的非Unicode字符串在配置的處理。
• 趕上OSErrors出現帶參數不明白調用時graphviz的。
• 恢復兼容Pygments＆GT;。= 1.2
• 修正了LaTeX的輸出轉義的目標hyperref宏

``作用LaTeX的輸出：DOC：由``生成
• 修復鏈接。
• 收集待辦事項節點在整個文檔已被讀取之後;這允許將替換在引用的待辦事項。
• 請不要忽視了一個明確的``today``配置在膠乳創造價值。
• 繼承圖的``alt``文本現在乾淨多了。
• 在生成的鏈接標題時忽略的章節標題圖片。
• 支持異常消息在``doctest``擴展的``testoutput``塊。
• 行塊在正確HTML輸出風格。
• 再次取得``locale_dirs``配置價值的工作。
• ``html_context``值給出通過``-A``不應該覆蓋conf.py給其他值在命令行上。
• 修正了一個錯誤預防增量的重建為``dirhtml``建設者。
• 修正了一些文字塊的報價是混淆。
• 修正路徑為``dirhtml``建設者的搜索索引。
• 解決Jython的兼容性問題：使``parser``模塊可選的依賴
。
• 在車博士，趕上了發生在模塊的進口，而不只是``ImportError``。
所有的錯誤
• 修正非數據的處理，但非法描述在車博士。
• 當複製文件時，忽略（）```用`os.utime提出OSErrors。

要求

• Pygments 1.2或更高版本
• 在神社2.3或更高版本
• docutils的0/7或更高