Sphinx常用插件汇总

Sphinx是什么？

• Sphinx是一个文档生成工具，它能够轻易地创建智能和优雅的文档。依托于reStructuredText和markdown格式的文件转换为各种输出格式，而且自动交叉引用、生成目录等。
• 快速入门教程：TODO

Sphinx常用插件(仅测试适用于sphinx-rtd-theme)

• [内置插件] sphinx.ext.githubpages ： 在生成html时创建.nojekyll文件，发布到Github Pages上
• [内置插件] sphinx.ext.napoleon: 用于同时支持google style 和 numpy style
• myst-parser : markdown格式支持工具
  • 可以直接渲染markdown格式的文件
  • 详细使用文档：docs
• sphinxcontrib.mermaid: 渲染mermaid流程图
  • pip install sphinxcontrib.mermaid
  • 注意mermaid需要用花括号包起来。
  • 详细说明文档：docs
• Sphinx Design
  • 用于设计漂亮的、屏幕大小的响应式 Web 组件的 Sphinx 扩展。
  • 详细使用文档：docs
• sphinx_copybutton 代码块右上角提供一键复制功能
  • pip install sphinx_copybutton
  • 在config.py下配置如下：

    # In your conf.py configuration file, add sphinx_copybutton to your extensions list. E.g.:
    
    extensions = [
        ...
        'sphinx_copybutton'
        ...
    ]
    
    #若要定义要从代码块中复制的文本中删除的提示文本
    copybutton_prompt_text = "myinputprompt"
    

参考资料

• Sphinx 扩展工具使用指南