Sphinx：如何添加角色和指令别名

Question

我经常使用:math:角色和.. math::指令，这种指令非常频繁，我想为它们制作一个较短的别名m。我怎样才能在Sphinx中实现它？

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