Sphinx官网

由于许多项目在其文档中需要特殊特性，Sphinx允许在构建过程中添加“扩展”，每个扩展几乎可以修改文档处理的任何方面。

本章介绍与Sphinx捆绑的插件。有关编写自己的扩展的API文档，请参阅：ref:dev extensions。

内置插件

这些插件是内置的，可以通过：confval:`extensions`配置值中的相应条目激活：

• ：模式：sphinx.ext.autodoc–包括来自docstrings的文档
  • 指令
  • 配置
  • 文档字符串预处理
  • 跳过成员
• ：模式：sphinx.ext.autosectionlabel–允许引用节使用其标题
  • 配置
• ：模式：sphinx.ext.自动摘要–生成自动文档摘要
  • ：program:sphinx autogen–生成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.继承图–包括继承关系图
  • 实际案例
  • 配置
• ：模式：sphinx.ext.intersphinx–链接到其他文档
  • 配置
  • 显示内部sphinx映射文件的所有链接
  • 在基本授权下使用Intersphinx和库存文件
• ：模式：sphinx.ext.linkcode–向源代码添加外部链接
  • 配置
• Sphinx中HTML输出的数学支持
  • ：模式：sphinx.ext.imgmath–将数学渲染为图像
  • ：模式：sphinx.ext.mathjax–通过JavaScript呈现数学
  • ：模式：sphinx.ext.jsmath–通过JavaScript呈现数学
• ：模式：sphinx.ext.napoleon——支持NumPy和Google风格的文档字符串
  • 概述
    • 快速上手
    • 文档字符串
    • 文档字符串部分
    • Google 和 NumPy
    • 类型批注
  • 配置
• ：模式：sphinx.ext.todo–支持todo项
  • 配置
• ：模式：sphinx.ext.viewcode–添加指向突出显示的源代码的链接
  • 配置