2010-08-18 99 views
0

我正在使用epydoc的reStructuredText。我如何讓內部鏈接的文本與鏈接的目標不同?我有:epydoc和reStructuredText更改鏈接名稱

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

產品鏈接看起來不錯,並鏈接到產品對象。 Product.manufacturer鏈接轉到正確的成員變量,而不是文本是Product.manufacturer,我想只是製造商。

我知道如果我使用epytext可以做到這一點,但是我們希望堅持使用reStructuredText,以便我們可以在以後切換文檔生成器。

回答

0

我不熟悉epydoc的自己,但正常的新結構化的方法是這樣的:

`manufacturer <Product.manufacturer>`_ 

或者與獅身人面像,

:attribute:`manufacturer <Product.manufacturer>` 

考慮到epydoc的似乎已經覆蓋默認提供鏈接的角色,它將留給它。然而,這是最有可能的工作:

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

可惜這只是指向實際的URL ../Product.manufacturer,而不是插入頁面的位置該對象 – lost 2013-02-07 12:21:30

+0

@lost:你這樣做在普通的reStructuredText中,作爲'\'製造商 \'_'(注意尾部下劃線),還是沒有下劃線(因此使它成爲「默認角色」)?前者會像你所描述的那樣工作,而聽起來後者應該起作用。 – 2013-02-07 18:24:45

+0

啊,我是用epydoc的_做的。然而,在epydoc中,編寫'store()'只會在輸出(固定寬度的字體)中生成「store()」和一個「failed identifier crossreference目標「警告」store()< baseplot.BasePlot.store()>「 – lost 2013-02-08 14:43:46