epydoc 和 reStructuredText 更改链接名称答案

【问题标题】：epydoc and reStructuredText change link nameepydoc 和 reStructuredText 更改链接名称
【发布时间】：2010-08-18 18:00:45
【问题描述】：

我将 reStructuredText 与 epydoc 一起使用。如何使内部链接的文本与链接的目标不同？我有：

:todo: Figure out the `Product.manufacturer` relationship in `Product`.

Product 链接看起来不错，并且链接到 Product 对象。 Product.manufacturer 链接指向正确的成员变量，但文本不是 Product.manufacturer，我只想成为制造商。

我知道如果我使用 epytext 可以做到这一点，但我们希望坚持使用 reStructuredText，以便我们以后可以根据需要切换文档生成器。

【问题讨论】：

【解决方案1】：

我自己并不熟悉 epydoc，但正常的 reStructuredText 方式是这样的：

`manufacturer <Product.manufacturer>`_

或者，与狮身人面像，

:attribute:`manufacturer <Product.manufacturer>`

考虑到 epydoc 似乎已经覆盖了提供链接的默认角色，它将留给它。然而，这是最有可能奏效的：

:todo: Figure out the `manufacturer <Product.manufacturer>` relationship in `Product`.

【讨论】：

不幸的是，这只是指向实际的 URL ../Product.manufacturer ，而不是为这个对象插入页面的位置
@lost：您是在纯 reStructuredText 中执行此操作，如`manufacturer <Product.manufacturer>`_（注意尾随下划线），还是没有下划线（因此使其成为“默认角色”）与 epydoc？前者会按照您的描述工作，而后者听起来应该可以工作。
啊，我是用 epydoc 中的 _ 做的。但是在 epydoc 中，编写 store()<baseplot.BasePlot.store()> 只会在输出（固定宽度字体）中生成“store()”，并为“store()"
哎呀它在“写作”之后吃掉了反引号
嗯，我不知道。当我回答这个问题时，我只是说这就是 reStructuredText 在其所有本机等价物中所做的事情（以及像 Sphinx 这样的其他事情因此而做的事情）。我不知道它可以在 epydoc 中工作，因为我还没有使用过它。