非索引方法的本地页面链接

Question

我正在使用sphinx来记录C ++项目，其中有许多页面记录了一个类。在这些示例中，我将:noindex:用于类方法，因为否则它们会使整个项目的索引页面变得混乱。

.. cpp:function:: void foo(int a)
    :noindex:

但是，这也带来的区别之一是我无法创建本地页面内链接。例如，在文档正文中使用其他方法：

The first argument is the same as that to :cpp:func:`foo`.

:noindex:上没有foo()，此链接有效。有了它，就不会产生错误，并且没有链接，但是它是死的/无用的/无处可走。

我该如何解决？

Answer 1

在reStructuredText中手动创建本地链接非常简单：

.. _`foo()`
.. cpp:function:: void foo(int a)
    :noindex:

定义目标，而不改变任何外观。要链接，

The first argument is the same as that to `foo()`_.

注意下划线的位置是从前到后。如果要包括括号，则需要打勾。如果标签是纯字母数字字符，则可以将其丢弃。

一些缺点：

• 您不能将其包装在标记中，例如，以等宽字体或强调链接文本。
• 似乎没有替代链接文本的方法。