Sphinx文档内容¶
- 介绍
- 安装
- 入门
- reStructuredText
- Markdown
- 配置
- 构建器
- 扩展
- 内置扩展
sphinx.ext.autodoc– 包括docstrings中的文档sphinx.ext.autosectionlabel– 允许使用其标题的参考部分sphinx.ext.autosummary– 生成autodoc摘要sphinx.ext.coverage– 收集doc覆盖率统计信息sphinx.ext.doctest– 测试文档中的代码片段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– 添加突出显示的源代码的链接
- 第三方扩展
- 内置扩展
- HTML
- 国际化
- Setuptools集成
- Web支持
- 手册页
- HTML主题支持
- 模板
- LaTeX 定制
- 开发扩展
- 扩展教程
- Sphinx 常问问题
- 术语
- Sphinx开发人员指南
- Sphinx更新
- 使用Sphinx的项目
- Sphinx作者
- Todo List