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

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

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

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

Use ``name`` to set the username

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

: param: не делаетработать вне списка информационных полей, чтобы вы моглия пишу

Use :param:`name` to set the username

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

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

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