epydoc和reStructuredText更改链接名称

时间:2010-08-18 18:00:46

标签: restructuredtext epydoc

我正在使用带有epydoc的reStructuredText。如何让内部链接的文本与链接的目标不同?我有:

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

Product链接看起来很好,并链接到Product对象。 Product.manufacturer链接转到正确的成员变量,但不是文本是Product.manufacturer,我只想成为制造商。

我知道如果我使用epytext可以做到这一点,但我们想坚持使用reStructuredText,以便我们可以在以后切换文档生成器。

1 个答案:

答案 0 :(得分:0)

我自己并不熟悉epydoc,但正常的reStructuredText方式是:

`manufacturer <Product.manufacturer>`_

或者,与Sphinx合作,

:attribute:`manufacturer <Product.manufacturer>`

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

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