Sphinx常用插件汇总
创始人
2025-05-30 02:33:16

目录

      • Sphinx是什么？
      • Sphinx常用插件(仅测试适用于sphinx-rtd-theme)
      • 参考资料

Sphinx是什么？

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

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

  • 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 扩展工具使用指南

上一篇：今日分享.,17麻将辅助软件.(外卦神器下载)

下一篇：今日重大通报“圣盛阳新麻将究竟是不是有挂”(其实是有挂)

相关内容

热门资讯

华纳收购战再升级！埃里森亲自兜... 甲骨文创始人拉里·埃里森（Larry Ellison）正动用其个人财富，为其子领导的派拉蒙（Para...
美国“万亿私募信贷大故事”正在... 美国私募信贷市场——这一曾被华尔街鼓吹为个人投资者“避风港”和稳定收益来源的万亿级领域，正面临着基本...
罗永浩录音还未公布，华与华兄弟... 澎湃新闻记者 戴高城12月22日，读客文化（301025.SZ）的一纸停牌公告，将华楠、华杉兄弟推上...
万亿长沙银行换帅，“70后”女... 出品｜达摩财经12月19日，长沙银行（601577.SH）发布公告称，该行董事会收到董事长赵小中的辞...
54岁恒隆集团CEO卢韦柏官宣... 红星资本局12月22日消息，日前，恒隆集团（00010.HK）、恒隆地产（00101.HK）联合公告...