sphinx.ext.githubpages
--在GitHub页面中发布HTML文档¶
Added in version 1.4.
在 2.0 版本发生变更: 支持 CNAME
文件
此扩展名创建 .nojekyll
生成的HTML目录上的文件,以在GitHub页上发布文档。
它还创建了一个 CNAME
自定义域的文件 html_baseurl
集合。
开始
用户指南
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风格的docstringssphinx.ext.todo
--对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页面中发布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风格的docstringssphinx.ext.todo
--对TODO项的支持sphinx.ext.viewcode
--添加指向突出显示的源代码的链接sphinx.ext.githubpages
--在GitHub页面中发布HTML文档¶Added in version 1.4.
在 2.0 版本发生变更: 支持 CNAME
文件
此扩展名创建 .nojekyll
生成的HTML目录上的文件,以在GitHub页上发布文档。
它还创建了一个 CNAME
自定义域的文件 html_baseurl
集合。