The Basics
User guide
sphinx.ext.autodoc -- Include documentation from docstringssphinx.ext.autosectionlabel -- 允许通过标题引用章节sphinx.ext.autosummary -- Generate autodoc summariessphinx.ext.coverage -- Collect doc coverage statssphinx.ext.doctest -- Test snippets in the documentationsphinx.ext.duration -- Measure durations of Sphinx processingsphinx.ext.extlinks -- 缩短外部链接的标记sphinx.ext.githubpages -- 在 GitHub Pages 上发布 HTML 文档sphinx.ext.graphviz -- 在文档中嵌入 Graphviz 图sphinx.ext.ifconfig -- Include content based on configurationsphinx.ext.imgconverter -- A reference image converter using Imagemagicksphinx.ext.inheritance_diagram -- Include inheritance diagramssphinx.ext.intersphinx -- 链接到其他项目的文档sphinx.ext.linkcode -- 添加到源代码的外部链接sphinx.ext.napoleon -- 支持 NumPy 和 Google 风格的文档字符串sphinx.ext.todo -- Support for todo itemssphinx.ext.viewcode -- 添加到高亮源代码的链接Community
Reference
sphinx.ext.autodoc -- Include documentation from docstringssphinx.ext.autosectionlabel -- 允许通过标题引用章节sphinx.ext.autosummary -- Generate autodoc summariessphinx.ext.coverage -- Collect doc coverage statssphinx.ext.doctest -- Test snippets in the documentationsphinx.ext.duration -- Measure durations of Sphinx processingsphinx.ext.extlinks -- 缩短外部链接的标记sphinx.ext.githubpages -- 在 GitHub Pages 上发布 HTML 文档sphinx.ext.graphviz -- 在文档中嵌入 Graphviz 图sphinx.ext.ifconfig -- Include content based on configurationsphinx.ext.imgconverter -- A reference image converter using Imagemagicksphinx.ext.inheritance_diagram -- Include inheritance diagramssphinx.ext.intersphinx -- 链接到其他项目的文档sphinx.ext.linkcode -- 添加到源代码的外部链接sphinx.ext.napoleon -- 支持 NumPy 和 Google 风格的文档字符串sphinx.ext.todo -- Support for todo itemssphinx.ext.viewcode -- 添加到高亮源代码的链接sphinx.ext.githubpages -- 在 GitHub Pages 上发布 HTML 文档¶Added in version 1.4.
Changed in version 2.0: 支持 CNAME 文件
此扩展在生成的 HTML 目录中创建 .nojekyll 文件，以在 GitHub Pages 上发布文档。
当设置 html_baseurl 时，它还为自定义域名创建 CNAME 文件。