Sphinx documentation contents
基礎知識
- 安裝 Sphinx
- 開始使用
- 建置您的第一個專案
使用者指南
- 使用 Sphinx
- reStructuredText
- Markdown
- 交叉參照
- 組態
- 建置器
StandaloneHTMLBuilder
DirectoryHTMLBuilder
SingleFileHTMLBuilder
HTMLHelpBuilder
QtHelpBuilder
AppleHelpBuilder
DevhelpBuilder
Epub3Builder
LaTeXBuilder
TextBuilder
ManualPageBuilder
TexinfoBuilder
SerializingHTMLBuilder
PickleHTMLBuilder
JSONHTMLBuilder
MessageCatalogBuilder
ChangesBuilder
DummyBuilder
CheckExternalLinksBuilder
XMLBuilder
PseudoXMLBuilder
- Serialization builder details
- 領域
- 擴充套件
- HTML 主題
- 國際化
- Sphinx Web Support
- 擴充 Sphinx
- Sphinx API
- LaTeX customization
社群
參考手冊
- 命令行工具
- 組態
- 專案標記
- 專案資訊
- 一般組態
needs_sphinx
extensions
needs_extensions
manpages_url
today
today_fmt
- Options for figure numbering
- Options for highlighting
- HTTP 請求的選項
- 國際化的選項
- Options for markup
- Options for Maths
- Options for the nitpicky mode
- Options for object signatures
- 來源檔的選項
- Options for smart quotes
- Options for templating
- Options for warning control
- 建置器選項
- 領域選項
- 擴充套件選項
- 範例組態檔
- 擴充套件
- 內建擴充套件
sphinx.ext.apidoc
-- 從 Python 軟體包生成 API 文件sphinx.ext.autodoc
-- Include documentation from docstringssphinx.ext.autosectionlabel
-- Allow referencing sections by their titlesphinx.ext.autosummary
-- Generate autodoc summariessphinx.ext.coverage
-- Collect doc coverage statssphinx.ext.doctest
-- Test snippets in the documentationsphinx.ext.duration
-- Measure durations of Sphinx processingsphinx.ext.extlinks
-- Markup to shorten external linkssphinx.ext.githubpages
-- Publish HTML docs in GitHub Pagessphinx.ext.graphviz
-- Add Graphviz graphssphinx.ext.ifconfig
-- Include content based on configurationsphinx.ext.imgconverter
-- A reference image converter using Imagemagicksphinx.ext.inheritance_diagram
-- Include inheritance diagramssphinx.ext.intersphinx
-- Link to other projects' documentationsphinx.ext.linkcode
-- Add external links to source code- Math support for HTML outputs in Sphinx
sphinx.ext.napoleon
-- Support for NumPy and Google style docstringssphinx.ext.todo
-- Support for todo itemssphinx.ext.viewcode
-- Add links to highlighted source code
- 第三方擴充套件
- 內建擴充套件
- reStructuredText
- 詞彙表
- 變更日誌
- Release 8.3.0 (in development)
- Prior releases
- Sphinx 8.2
- 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 的專案
- 使用 alabaster 主題的文件
- 使用 classic 主題的文件
- 使用 sphinxdoc 主題的文件
- 使用 nature 主題的文件
- 使用其他內建主題的文件
- 使用 Read the Docs Sphinx 主題的文件
- 使用 Sphinx Bootstrap 主題的文件
- 使用 PyData Sphinx 主題的文件
- 使用 Furo 主題的文件
- 使用自訂主題或整合於網站中的文件
- Homepages and other non-documentation sites
- Books produced using Sphinx
- Theses produced using Sphinx
- Projects integrating Sphinx functionality