Sphinx html变量

时间:2017-06-16 14:12:00

标签: python-sphinx

我试图在conf.py中设置一个变量,插入一个应用于字符串的链接:

rst_epilog = """
.. |support| replace:: `support team <support@blabla.com>`_
"""

在这种情况下,支持团队&#39;会变成指向电子邮件地址的链接。

不幸的是,这不起作用,构建中断了。

所以我尝试在那里转储HTML,不知道替换何时发生,但它发生在HTML转换之前,因此在我的输出中不起作用。

rst_epilog = """
.. |support| replace:: <a href="support@blabla.com">support team</a>
"""

我知道我可以用变量吗?

1 个答案:

答案 0 :(得分:0)

使用此替换定义:

.. |support| replace:: support team support@blabla.com

support@blabla.com会自动识别为mailto个链接。

|support|替换引用会产生以下输出:

support team <a class="reference external" href="mailto:support&#37;&#52;&#48;blabla&#46;com">support<span>&#64;</span>blabla<span>&#46;</span>com</a>

另一种方法是使用raw-html角色(请参阅http://docutils.sourceforge.net/docs/ref/rst/roles.html#raw)。

将此添加到conf.py:

rst_epilog = """
.. role:: raw-html(raw)
   :format: html

.. |support| replace:: :raw-html:`<a href="mailto:support@blabla.com">support team</a>`
"""