epydoc и reStructuredText меняют имя ссылки - PullRequest
0 голосов
/ 18 августа 2010

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

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

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

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

1 Ответ

0 голосов
/ 30 ноября 2010

Я сам не знаком с epydoc, но обычный способ reStructuredText был бы таким:

`manufacturer <Product.manufacturer>`_

или со сфинксом

:attribute:`manufacturer <Product.manufacturer>`

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

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