Sphinx 扩展汇总

• sphinx-design

自带插件

构建

• 推荐 sphinx-autobuild

  Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.

代码

• 推荐 sphinx-copybutton

  Add a "copy" button to code blocks in Sphinx.

• 废弃 sphinx-prompt

  Sphinx directive to add unselectable prompt.

  sphinx-copybutton 拥有更完善的方案，可以将命令和输出放在同一个代码块，且只复制命令。

Tab

• 推荐 sphinx-tabs

  Tabbed views for Sphinx.

• 推荐 sphinx-inline-tabs

  Add inline tabbed content to your Sphinx documentation.

  功能同 sphinx-tabs，样式存在差异

Web

• 推荐 sphinx-notfound-page

  Create a custom 404 page with absolute URLs hardcoded

文本

• 待定 sphinxnotes-strike

  An extension that adds strikethrough text support to Sphinx

  官方居然不支持删除线，还是期待官方解决该问题。

• 推荐 sphinx-cjkspace

  Sphinx extension to remove extra whitespaces between CJK characters

  中文写作必备

图片

• 推荐 sphinxcontrib-mermaid

  Mermaid diagrams in yours sphinx powered docs

  正在寻找维护者，后续情况不明朗

• 推荐 sphinxcontrib-kroki

  Embed PlantUML, DOT, etc. diagrams in your documentation using Kroki.

标签

• 待定 sphinx-tags

  A tiny Sphinx extension that implements blog-style tags for documentation.

其它

• 推荐 sphinx-hoverxref

  Sphinx extension to show tooltips with content embedded when hover a reference.

• 推荐 sphinx-togglebutton

  Show and hide content with a button in Sphinx

• 推荐 https://github.com/ulrobix/sphinxcontrib-contentui

• https://github.com/humitos/sphinx-version-warning

• https://github.com/coldfix/sphinx-code-tabs

• https://github.com/click-contrib/sphinx-click

• https://github.com/sphinx-contrib/sphinxcontrib-versioning

• https://github.com/bitprophet/releases

• https://github.com/bosbyj/sphinx.search.zh_CN

• https://github.com/executablebooks/sphinx-design

• https://github.com/sphinx-toolbox/sphinx-toolbox

• https://github.com/sphinx-contrib/kroki