基础知识
用户指南
sphinx.ext.apidoc – 从 Python 包生成 API 文档sphinx.ext.autodoc – 包含来自 docstring 的文档sphinx.ext.autosectionlabel – 允许通过标题引用节sphinx.ext.autosummary – 生成自动文档摘要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.ext.napoleon – 支持 NumPy 和 Google 风格的 docstringsphinx.ext.todo – 支持待办事项sphinx.ext.viewcode – 添加指向高亮源代码的链接社区
参考
sphinx.ext.apidoc – 从 Python 包生成 API 文档sphinx.ext.autodoc – 包含来自 docstring 的文档sphinx.ext.autosectionlabel – 允许通过标题引用节sphinx.ext.autosummary – 生成自动文档摘要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.ext.napoleon – 支持 NumPy 和 Google 风格的 docstringsphinx.ext.todo – 支持待办事项sphinx.ext.viewcode – 添加指向高亮源代码的链接sphinx.ext.githubpages – 在 GitHub Pages 中发布 HTML 文档¶版本 1.4 中新增。
版本 2.0 中更改: 支持 CNAME 文件
此扩展会在生成的 HTML 目录中创建 .nojekyll 文件，以便在 GitHub Pages 上发布文档。
当 html_baseurl 设置时，它还会为自定义域名创建一个 CNAME 文件。