开发扩展概述

本页包含有关开发Sphinx扩展的一般信息。

使一个扩展依赖于另一个扩展

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

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

例如,以下代码激活 recommonmark 扩展:

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

备注

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