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

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

相关内容

热门资讯

2026 CES 霞光社&qu... 合作伙伴 & 招募持续进行中无论您是希望登上Panel畅谈前沿观点的思想者，还是希望成为我们探展镜头...
快手开盘股价直线下跌，黑灰产攻... 12月23日，港股开盘，快手（1024.HK）股价直线下跌。截至发稿，股价62.9港元，跌5.7%。...
你们四川人的嘴太严了 你究竟还藏了多少秘密？听说斯基在乐山，波旁斯基张口就来：乐山美食经济三驾马车：甜皮鸭、跷脚牛肉和钵钵...
海南板块大幅高开 12月23日早盘，海南板块大幅高开，海峡股份、海汽集团、海南发展、海南瑞泽涨停，康芝药业、海南机场、...
化工品轮番涨价 高端产能有序扩... 近期MDI、碳酸锂等化工品轮番涨价，涨价潮驱动化工板块表现活跃。其中，在能源成本、运输成本与环保压力...