Depend on another extension¶

Parfois, votre extension dépend des fonctionnalités d’une autre extension Sphinx. La plupart des extensions Sphinx sont activées dans un fichier du projet conf.py, mais ce n’est pas accessible pour vous en tant que développeur d’extension.

Pour garantir qu’une autre extension est activée comme partie de votre propre extension, utiliser la méthode sphinx.application.Sphinx.setup_extension(). Cela permettra d’activer une autre extension lors de l’exécution, afin d’être sûr que vous ayez accès à ses fonctionnalités.

For example, the following code activates the sphinx.ext.autodoc extension:

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

Note

Puisque votre extension va dépendre d’une autre, vérifiez que vous l’avez incluse dans les pré-requis d’installation de votre extension.