在sphinx中使用自定义html编写器

时间:2013-03-21 18:15:14

标签: python documentation python-sphinx

如何在HTMLTranslator中使用与Sphinx附带的sphinx.writers.html不同的depart_desc_signature

具体来说,我想修改方法{{1}}。我无法修改Sphinx本身,因为帮助文件正在与其他人一起开发,需要使用标准Sphinx正确编译。

我知道Sphinx支持:

1 个答案:

答案 0 :(得分:0)

通过在html_translator_class中定义conf.py来指定html翻译器。

例如,

html_translator_class = 'html2.HTMLTranslator'

虽然这对mathjax不好用,所以如果html2sphinx.writers.html的副本,你需要显式地将对mathjax的调用添加到HTMLTranslator:

def visit_displaymath(self, node):
    import sphinx.ext.mathjax
    sphinx.ext.mathjax.html_visit_displaymath(self, node)
def depart_displaymath(self, node):
    return
def visit_math(self, node):
    import sphinx.ext.mathjax
    sphinx.ext.mathjax.html_visit_math(self, node)
def depart_math(self, node):
    return