如何在Python Sphinx中转义双冒号

2 投票
1 回答
901 浏览
提问于 2025-04-17 23:49

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

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

你可能已经明白,双冒号会干扰官方的 Sphinx 语法,虽然它会显示出来,但这个方法并没有链接(也就是说,不能通过 :method: 这样的方式访问)。

添加转义符号(\)并没有真正解决问题,虽然它仍然显示出来,但链接还是无法使用。有没有什么解决办法,还是说这是 Sphinx 平台无法避免的限制呢?

1 个回答

1

你应该可以在Sphinx中使用C++领域。用法如下:

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

对这个方法的交叉引用看起来像这样:

:cpp:func:`Foo::Bar`

撰写回答