epydoc and reStructuredText change link name

Question

I'm using reStructuredText with epydoc. How can I have the text of an internal link different than the target of the link? I have:

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

The Product link looks fine and links to the Product object. The Product.manufacturer link goes to the proper member variable, but instead of the text being Product.manufacturer, I'd like to just be manufacturer.

I know this can be done if I use epytext, but we'd like to stick with reStructuredText so that we can switch documentation generators later if we want to.

Answer 1

I'm not familiar with epydoc myself, but the normal reStructuredText way would be this:

`manufacturer <Product.manufacturer>`_

Or, with Sphinx,

:attribute:`manufacturer <Product.manufacturer>`

Considering that epydoc seems to have overridden the default role to provide links, it will be being left to it. However, this is the most likely to work:

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