拡張機能の開発の概要

このページでは Sphinx 拡張機能の開発に関する一般的な情報が書かれています。

他の拡張機能に依存する拡張の作成

あなたの拡張が他のSphinxの拡張機能に依存していることが、時としてあります。ほとんどのSphinx拡張機能は各プロジェクトの conf.py ファイル内でアクティベートされますが,一拡張開発者としてあなたが都度そこまで設定することはできません。

あなたの拡張機能の一部として他の拡張を確実にアクティベートするためには、 Sphinx.setup_extension() メソッドを使用してください.これにより他の拡張機能が実行時にアクティベートされ、あなたがその機能に確実にアクセスできるようになります。

例えば、次のコードは recommonmark 拡張をアクティベートするものです:

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

注釈

あなたの拡張機能が他のものに依存するとき、拡張のインストール条件の一環としてそれを必ずインクルードするようにしてください。