Sphinx: как добавить роль и псевдоним директивы

Question

Я часто использую роль :math: и .. math::, что так часто, что я хочу сделать более короткий псевдоним m для них. Как я могу достичь этого в Сфинксе?

Answer 1

Добавьте следующий фрагмент кода в conf.py. Он определяет m директиву и m роль, которую можно использовать в качестве псевдонимов math:

from sphinx.ext.mathbase import MathDirective, math_role 

def setup(app): 
    app.add_directive('m', MathDirective) 
    app.add_role('m', math_role) 

Смотрите также:

• http://sphinx-doc.org/extdev/tutorial.html#the-setup-function
• http://sphinx-doc.org/extdev/appapi.html