Sphinx 文档内容
基础
用户指南
- 使用 Sphinx
- reStructuredText
- Markdown
- 交叉引用语法
- 配置
- 生成器
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- 序列化生成器详情
- 域
- 扩展
- HTML 主题
- 国际化
- Sphinx Web 支持
- 扩展 Sphinx
- Sphinx API
- LaTeX 自定义
社区
参考
- 命令行工具
- 配置
- 扩展
- 内置扩展
sphinx.ext.autodoc– 从文档字符串包含文档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 风格的文档字符串sphinx.ext.todo– 支持待办事项sphinx.ext.viewcode– 添加到突出显示源代码的链接
- 第三方扩展
- 内置扩展
- reStructuredText
- 术语表
- 变更日志
- 版本 8.1.0 (开发中)
- 先前版本
- 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 的项目