依赖其他扩展

有时你的扩展依赖于另一个 Sphinx 扩展的功能。大多数 Sphinx 扩展在项目的 conf.py 文件中激活,但作为扩展开发者,你无法访问此文件。

为了确保另一个扩展作为你自己的扩展的一部分被激活,请使用 sphinx.application.Sphinx.setup_extension() 方法。这将在运行时激活另一个扩展,确保你可以访问其功能。

例如,以下代码激活了 sphinx.ext.autodoc 扩展

def setup(app):
    app.setup_extension('sphinx.ext.autodoc')

注意

由于你的扩展将依赖于另一个扩展,请确保将其包含在你的扩展的安装需求中。