epydoc и reStructuredText меняют имя ссылки

Question

Я использую reStructuredText с epydoc. Как я могу иметь текст внутренней ссылки, отличной от цели ссылки? Я имею:

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

Ссылка на продукт выглядит хорошо и ссылается на объект Product. Ссылка Product.manufacturer ведет к правильной переменной-члену, но вместо текста Product.manufacturer я хотел бы просто быть производителем.

Я знаю, что это можно сделать, если я использую epytext, но мы хотели бы использовать reStructuredText, чтобы мы могли переключать генераторы документации позже, если захотим.

Answer 1

Я сам не знаком с epydoc, но обычным способом reStructuredText было бы следующее:

`manufacturer <Product.manufacturer>`_

Или со Сфинксом,

:attribute:`manufacturer <Product.manufacturer>`

Учитывая, что epydoc, по-видимому, переопределил роль по умолчанию для предоставления ссылок, он останется за ним. Тем не менее, это наиболее вероятно сработает:

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