依赖于另一个扩展¶

有时您的扩展依赖于另一个 Sphinx 扩展的功能.大多数 Sphinx 扩展是在项目的 conf.py 文件中激活的,但这对您作为扩展开发者来说并不可用.

要确保另一个扩展在您的扩展中被激活,请使用 sphinx.application.Sphinx.setup_extension() 方法.这将在运行时激活另一个扩展,确保您可以访问其功能.

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

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

备注

由于您的扩展将依赖于另一个扩展,请确保将其作为您扩展安装要求的一部分.