Sphinx 文档目录
基础知识
用户指南
- 使用 Sphinx
- reStructuredText
- Markdown
- 交叉引用
- 配置
- 构建器
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- 序列化构建器详细信息
- 域
- 扩展
- HTML主题
- 国际化
- Sphinx Web支持
- 扩展 Sphinx
- Sphinx API接口
- LaTeX个性化
社区
参考
- 命令行工具
- 配置
- 扩展
- 内置插件
sphinx.ext.apidoc-- 利用 Python 包产生 API 文档sphinx.ext.autodoc-- 纳入来自docstrings的文档sphinx.ext.autosectionlabel-- 通过标题引用章节sphinx.ext.autosummary-- 生成 autodoc 摘要sphinx.ext.coverage-- 收集文档覆盖率统计信息sphinx.ext.doctest-- 文档中的测试片段sphinx.ext.duration-- 测量Sphinx处理持续的时间sphinx.ext.extlinks-- 标记以缩短外部链接sphinx.ext.githubpages-- 在GitHub页面中发布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风格的文档字符串sphinx.ext.todo-- 支持todo项sphinx.ext.viewcode-- 添加指向突出显示的源代码的链接
- 第三方插件
- 内置插件
- reStructuredText
- 术语表
- 更新日志
- Release 9.1.1 (in development)
- Release 9.1.0 (released Dec 31, 2025)
- Prior releases
- Sphinx 9.0
- 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的项目