Sphinx文档目录
基础知识
用户指南
- 使用Sphinx
- 重新构造文本
- Markdown
- 交叉引用
- 配置
- 构建器
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- 序列化构建器详细信息
- 域
- 延拓
- HTML主题
- 国际化
- Sphinx Web支持
- 扩展Sphinx
- SphinxAPI
- Latex 定制
社区
参考
- 命令行工具
- 配置
- 延拓
- 内置扩展模块
sphinx.ext.apidoc--从Python包生成API文档sphinx.ext.autodoc--包括文档字符串中的文档sphinx.ext.autosectionlabel--允许通过标题引用部分sphinx.ext.autosummary--生成自动文档摘要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--支持待办事项sphinx.ext.viewcode--添加指向突出显示的源代码的链接
- 第三方扩展
- 内置扩展模块
- 重新构造文本
- 术语表
- Changelog
- 版本8.3.0（开发中）
- 先前版本
- Sphinx8.2
- Sphinx8.1
- Sphinx8.0
- Sphinx7.4
- Sphinx7.3
- Sphinx7.2
- Sphinx7.1
- Sphinx7.0
- Sphinx6.2
- Sphinx6.1
- Sphinx6.0
- Sphinx5.3
- Sphinx5.2
- Sphinx5.1
- Sphinx5.0
- Sphinx4.5
- Sphinx4.4
- Sphinx4.3
- Sphinx 4.2
- Sphinx4.1
- Sphinx4.0
- Sphinx3.5
- Sphinx3.4
- Sphinx3.3
- Sphinx3.2
- Sphinx 3.1
- Sphinx3.0
- Sphinx2.4
- Sphinx 2.3
- Sphinx2.2
- Sphinx2.1
- Sphinx2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx1.6
- Sphinx1.5
- Sphinx1.4
- Sphinx1.3
- Sphinx1.2
- Sphinx1.1
- Sphinx1.0
- Sphinx0.6
- Sphinx0.5
- Sphinx0.4
- Sphinx0.3
- Sphinx0.2
- Sphinx0.1
- 使用Sphinx的项目