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麻将辅助软件.(外卦神器下载)

下一篇：重磅消息.手中畅游真的有挂吗.曝光开挂猫腻!

相关内容

热门资讯

事关动力电池！全国人大代表、赣... 本文来源：时代周报 作者：雨辰当前，低空经济正成为全球科技与产业竞争的新赛道，市场规模持续扩容。据机...
从中国首富到被集体看空，雷总经... 小米，最近被集体看空…还记得，去年差不多这时候，小米风光无限。小米SU7卖爆了，小米手机高端化也进展...
五粮液抗血栓？“学术营销”又翻... “喝五粮液能抗血栓，效果比阿司匹林还好”——这样一则看似颠覆认知的结论，近期再度引发全网热议。事实上...
机器人赛道再“进化” 谁在驱动... 《金证研》 巽风/作者2026年2月28日，人形机器人与具身智能标准化（HEIS）年会在北京召开，会...
原油取代金银成年内涨幅最大资产... 全文共1895字，阅读全文约需4分钟此举被视为监管部门在当前地缘政治紧张背景下，为防范市场风险、抑制...