开发插件的概述

本页包含关于开发 Sphinx 插件的一般信息。

使一个插件依赖于另一个插件

有时你的插件依赖于另一个 Sphinx 插件的功能。大多数 Sphinx 插件是在项目的 conf.py 文件中激活的，但作为插件的开发者，这是不可以的。

为了确保另一个插件被激活为你自己插件的一部分，使用 Sphinx.setup_extension() 方法。这将在运行时激活另一个插件，确保你可以使用它的功能。

例如，以下代码激活了 recommonmark 插件。

def setup(app):
    app.setup_extension("recommonmark")

备注

由于你的插件将依赖于另一个，请确保将其作为你的插件安装要求的一部分。