如何在Python Sphinx中逃避双冒号

时间:2014-03-25 13:24:56

标签: python escaping python-sphinx

我们假设我们有以下FireBreath调用:

.. method:: Foo::Bar(std::vector)

正如您可能已经理解的那样,双冒号会干扰官方的Sphinx语法,虽然它确实显示出来,但是没有与此方法相关的链接(即无法通过:method:引用访问它例如)。

添加转义符号(\)并没有真正帮助,虽然它仍然显示,但链接不起作用。是否有任何解决方法或这是Sphinx平台不可避免的限制?

1 个答案:

答案 0 :(得分:1)

您应该可以在Sphinx中使用C++ domain。像这样:

.. cpp:function:: Foo::Bar(std::vector)

此方法的交叉引用如下所示:

:cpp:func:`Foo::Bar`