Sphinx文档目录
开始
用户指南
- 使用 Sphinx
- reStructuredText
- Markdown
- 交叉引用语法
- 配置
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- 序列化生成器详细信息
- 领域
- 扩展
- HTML主题化
- 国际化
- Sphinx Web支持
- 编写Sphinx扩展
- Latex 定制
- Sphinx扩展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风格的docstringssphinx.ext.todo--对TODO项的支持sphinx.ext.viewcode--添加指向突出显示的源代码的链接
- 第三方扩展
- 内置扩展
- reStructuredText
- 术语表
- Changelog
- 使用Sphinx的项目