sphinx.ext.githubpages -- 在GitHub页面中发布HTML文档¶
在 1.4 版本加入.
在 2.0 版本发生变更: 支持“CNAME”文件
此扩展在生成的HTML目录上创建“.nojekyll”文件,以便在GitHub页面上发布文档。
当 html_baseurl set时,它还为自定义域创建一个“CNAME”文件。
基础知识
用户指南
sphinx.ext.apidoc -- 利用 Python 包产生 API 文档sphinx.ext.autodoc -- 纳入来自docstrings的文档sphinx.ext.autosectionlabel -- 通过标题引用章节sphinx.ext.autosummary -- 生成 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.inheritance_diagram -- 包含继承关系图sphinx.ext.intersphinx -- 链接到其他文档sphinx.ext.linkcode -- 向源代码添加外部链接sphinx.ext.napoleon -- 支持NumPy和Google风格的文档字符串sphinx.ext.todo -- 支持todo项sphinx.ext.viewcode -- 添加指向突出显示的源代码的链接社区
参考
sphinx.ext.apidoc -- 利用 Python 包产生 API 文档sphinx.ext.autodoc -- 纳入来自docstrings的文档sphinx.ext.autosectionlabel -- 通过标题引用章节sphinx.ext.autosummary -- 生成 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.inheritance_diagram -- 包含继承关系图sphinx.ext.intersphinx -- 链接到其他文档sphinx.ext.linkcode -- 向源代码添加外部链接sphinx.ext.napoleon -- 支持NumPy和Google风格的文档字符串sphinx.ext.todo -- 支持todo项sphinx.ext.viewcode -- 添加指向突出显示的源代码的链接sphinx.ext.githubpages -- 在GitHub页面中发布HTML文档¶在 1.4 版本加入.
在 2.0 版本发生变更: 支持“CNAME”文件
此扩展在生成的HTML目录上创建“.nojekyll”文件,以便在GitHub页面上发布文档。
当 html_baseurl set时,它还为自定义域创建一个“CNAME”文件。