歡迎光臨

用戶說什么:

“為一個能讓程序員真正想要的偉大工具干杯“

Sphinx是一種工具,由Georg Brandl編寫并根據BSD許可證授權,它使得創造靈活和美觀的文檔變得容易。

它最初是為 Python文檔 而創建。它具有出色的設施,可以記錄各種語言的軟件項目。 當然,這個站點(文檔)也是使用Sphinx從reStructuredText源創建的! 應突出顯示以下功能:

  • 輸出格式:HTML(包括Windows HTML幫助),LaTex(for printable PDF versions), ePub, Texinfo, manual pages, plain text
  • 廣泛的交叉引用: 語義標記和函數,類,引用,術語和類似信息的自動鏈接
  • 層次結構:輕松定義文檔樹,自動鏈接到兄弟姐妹,父母和孩子 。
  • 自動索引: 通用索引,以及用于特定語言的模塊索引
  • 代碼處理: 使用Pygments 自動高亮顯示
  • 擴展: 自動測試代碼片段,包含Python模塊中的文檔字符串(API文檔), 及更多
  • 貢獻的擴展: more than 在其他倉儲庫中由 用戶貢獻 的 50余擴展, 大部分可以通過 PyPI 安裝。

Sphinx使用 reStructuredText 作為標記語言,它的許多優點來自于reStructuredText及其解析和翻譯套件的強大功能和直接性,即: Docutils

文檔

您還可以下載sphinx文檔的pdf/epub版本

實際案例

查看使用Sphinx生成的文檔的鏈接: 使用 Sphinx 的項目 頁面。

有關sphinx源文件外觀的示例,請使用 ``Show source`` 鏈接顯示。

你也可能對 教程 非常有興趣,關于如何使用 Matplotlib開發人員編寫的Sphinx創建自定義文檔。

有一個本文檔的日語翻譯,thanks to the Japanese Sphinx user group

O'Reilly 出版了一本關于Sphinx的日語圖書:Sphinxをはじめよう Learning Sphinx.

2019年,德國出版了第二版關于斯芬克斯的書:

托管

需要一個地方來托管你的 Sphinx 文檔 嗎? readthedocs.org 已經擁有很多Sphinx文檔,并且與項目的源代碼控制很好地集成。 它還具有強大的內置搜索功能,超出了Sphinx基于JavaScript的離線搜索功能。

參與者指南

如果你想為這個項目做貢獻,