依赖另一个扩展

有时您的扩展依赖于另一个Sphinx扩展的功能。大多数Sphinx扩展在项目的 conf.py 文件中激活,但作为扩展开发人员不能使用此文件。

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

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

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

备注

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