Sphinx documentation contents
The Basics
- Installing Sphinx
- Getting started
- Build your first project
User guide
- Using Sphinx
- reStructuredText
- Markdown
- Cross-references
- 配置
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- Serialization builder details
- Domains
- 插件
- HTML theming
- 国际化
- Sphinx Web Support
- Extending Sphinx
- Sphinx API
- LaTeX customization
Community
- Get support
- Contribute to Sphinx
- Sphinx FAQ
- Sphinx authors
Reference
- Command-line tools
- 配置
- 项目标签
- 项目信息
- 通用配置
- Builder options
- Options for HTML output
- Options for Single HTML output
- Options for HTML help output
- Options for Apple Help output
- Options for EPUB output
- Options for LaTeX output
- Options for text output
- Options for manual page output
- Options for Texinfo output
- Options for QtHelp output
- Options for XML output
- Options for the linkcheck builder
- Domain options
- Extension options
- Example configuration file
- 插件
- 内建插件
sphinx.ext.autodoc-- Include documentation from docstringssphinx.ext.autosectionlabel-- 允许通过标题引用章节sphinx.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-- 缩短外部链接的标记sphinx.ext.githubpages-- 在 GitHub Pages 上发布 HTML 文档sphinx.ext.graphviz-- 在文档中嵌入 Graphviz 图sphinx.ext.ifconfig-- Include content based on configurationsphinx.ext.imgconverter-- A reference image converter using Imagemagicksphinx.ext.inheritance_diagram-- Include inheritance diagramssphinx.ext.intersphinx-- 链接到其他项目的文档sphinx.ext.linkcode-- 添加到源代码的外部链接- Math support for HTML outputs in Sphinx
sphinx.ext.napoleon-- 支持 NumPy 和 Google 风格的文档字符串sphinx.ext.todo-- Support for todo itemssphinx.ext.viewcode-- 添加到高亮源代码的链接
- 第三方插件
- 内建插件
- reStructuredText
- 术语表
- Changelog
- Release 8.2.0 (in development)
- Prior releases
- 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
- Projects using Sphinx
- Documentation using the alabaster theme
- Documentation using the classic theme
- Documentation using the sphinxdoc theme
- Documentation using the nature theme
- Documentation using another builtin theme
- Documentation using Read the Docs Sphinx Theme
- Documentation using Sphinx Bootstrap Theme
- Documentation using PyData Sphinx Theme
- Documentation using Furo theme
- Documentation using a custom theme or integrated in a website
- Homepages and other non-documentation sites
- Books produced using Sphinx
- Theses produced using Sphinx
- Projects integrating Sphinx functionality