Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте.

Итак, я знаком ссписки информационных полей и я знаком с использованиемперекрестные ссылки в наших документах.

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

Мы могли бы сказать, например,

Use ``name`` to set the username

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

: param: не работает вне списка информационных полей, поэтому вы не можете писать

Use :param:`name` to set the username

Я видел, как некоторые проекты используют: parm: но это не задокументировано и, похоже, не работает. Таким образом, они должны иметь некоторые настройки

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

Надеюсь, я только что пропустил что-то ослепительно очевидное.