Sphinx 扩展模块

6. Sphinx 扩展模块#

Sphinx 扩展模块有内置扩展和第三方扩展之分。扩展模块的命名格式以 sphinx.ext. 开头；否则就是（前提它是 Sphinx 插件）。所有 Sphinx 插件都是需要在 conf.py 中添加到扩展后才会启用。

内置扩展的使用不需要额外安装，其相关程序在安装 Sphinx 时会一并安装。第三方扩展则需要安装后才能使用。

直接在 conf.py 文件中的 extensions 数组中添加扩展名称的字符串后，然后根据需要添加一些其他配置代码的情况下即可直接生效。

例如 sphinx_copybutton 插件：

# In your conf.py configuration file, add sphinx_copybutton to your extensions list. E.g.:

extensions = [
    ...
    'sphinx_copybutton'
    ...
]

#若要定义要从代码块中复制的文本中删除的提示文本
copybutton_prompt_text = "myinputprompt"