基础知识
用户指南
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 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风格的文档字符串sphinx.ext.todo – 待办事项支持sphinx.ext.viewcode – 添加链接到高亮的源代码社区
参考
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 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风格的文档字符串sphinx.ext.todo – 待办事项支持sphinx.ext.viewcode – 添加链接到高亮的源代码sphinx.ext.githubpages – 在 GitHub Pages 上发布 HTML 文档¶Added in version 1.4.
在 2.0 版本发生变更: 支持 CNAME 文件
此扩展在生成的HTML目录中创建 .nojekyll 文件,以便在GitHub Pages上发布文档.
当设置了 html_baseurl 时,它还会为自定义域创建一个 CNAME 文件.