Visão geral do desenvolvimento de extensões

Esta página contém informações gerais sobre o desenvolvimento de extensões Sphinx.

Fazer uma extensão depender de outra extensão

Às vezes, sua extensão depende da funcionalidade de outra extensão Sphinx. A maioria das extensões Sphinx são ativadas no arquivo conf.py de um projeto, mas isso não está disponível para você como desenvolvedor de extensões.

To ensure that another extension is activated as a part of your own extension, use the sphinx.application.Sphinx.setup_extension() method. This will activate another extension at run-time, ensuring that you have access to its functionality.

Por exemplo, o código a seguir ativa a extensão recommonmark:

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

Nota

Visto que sua extensão dependerá de outra, certifique-se de incluí-la como parte dos requisitos de instalação de sua extensão.