Sphinx 文件內容
基礎概念
- 安裝 Sphinx
- 開始使用
- 建立您的第一個專案
使用者指南
- 使用 Sphinx
- reStructuredText
- Markdown
- 交叉參照
- 設定
- 建置器
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- 序列化建置器詳細資訊
- 網域
- 擴充套件
- HTML 主題
- 國際化
- Sphinx 網路支援
- 擴充 Sphinx
- Sphinx API
- LaTeX 客製化
社群
參考
- 命令列工具
- 設定
- 擴充套件
- 內建擴充套件
sphinx.ext.apidoc– 從 Python 套件產生 API 文件sphinx.ext.autodoc– 從 docstring 包含文件sphinx.ext.autosectionlabel– 允許依標題參照章節sphinx.ext.autosummary– 產生 autodoc 摘要sphinx.ext.coverage– 收集文件涵蓋率統計資訊sphinx.ext.doctest– 測試文件中的程式碼片段sphinx.ext.duration– 測量 Sphinx 處理時間sphinx.ext.extlinks– 縮短外部連結的標記sphinx.ext.githubpages– 在 GitHub Pages 中發布 HTML 文件sphinx.ext.graphviz– 新增 Graphviz 圖形sphinx.ext.ifconfig– 根據設定包含內容sphinx.ext.imgconverter– 使用 Imagemagick 的參考影像轉換器sphinx.ext.inheritance_diagram– 包含繼承圖sphinx.ext.intersphinx– 連結到其他專案的文件sphinx.ext.linkcode– 新增程式碼來源的外部連結- Sphinx 中 HTML 輸出的數學支援
sphinx.ext.napoleon– 支援 NumPy 和 Google 風格的 docstringsphinx.ext.todo– 支援 todo 項目sphinx.ext.viewcode– 新增連結到醒目提示的原始碼
- 第三方擴充套件
- 內建擴充套件
- reStructuredText
- 詞彙表
- 變更日誌
- 版本 8.2.0 (於 2025 年 2 月 18 日發布)
- 先前的版本
- Sphinx 8.1
- Sphinx 8.0
- Sphinx 7.4
- Sphinx 7.3
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Sphinx 1.3
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1
- 使用 Sphinx 的專案