sphinx.ext.githubpages --在GitHub页面中发布HTML文档¶
Added in version 1.4.
在 2.0 版本发生变更: 支持 CNAME 文件
此扩展创建 .nojekyll 文件，以在GitHub页面上发布文档。
它还创建了一个 CNAME 自定义域的文件 html_baseurl 准备好了。
基础知识
用户指南
sphinx.ext.apidoc --从Python包生成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.ext.napoleon --支持NumPy和Google样式的文档字符串sphinx.ext.todo --支持待办事项sphinx.ext.viewcode --添加指向突出显示的源代码的链接社区
参考
sphinx.ext.apidoc --从Python包生成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.ext.napoleon --支持NumPy和Google样式的文档字符串sphinx.ext.todo --支持待办事项sphinx.ext.viewcode --添加指向突出显示的源代码的链接sphinx.ext.githubpages --在GitHub页面中发布HTML文档¶Added in version 1.4.
在 2.0 版本发生变更: 支持 CNAME 文件
此扩展创建 .nojekyll 文件，以在GitHub页面上发布文档。
它还创建了一个 CNAME 自定义域的文件 html_baseurl 准备好了。