Używam funkcji Sphinx i autodocs, aby mieć pewność, że mamy dobre dokumenty w naszym projekcie.

Znam tolisty pól informacyjnych i jestem zaznajomiony z używaniemodsyłacze w naszych dokumentach.

Jednak pisząc dokumentację do metody lub funkcji, uważam, że warto odwołać się do ich parametrów w tekście. Ale nie wydaje się, aby był to zorganizowany sposób.

Moglibyśmy powiedzieć np.

Use ``name`` to set the username

ale to nie ma struktury, wymaga zapamiętania stylu, w jakim się do tego użyłeś, a jeśli zmienisz styl, musisz upolować i zabić wszystkie nieprawidłowe style.

: param: nie działa poza listą pól informacyjnych, więc nie możesz pisać

Use :param:`name` to set the username

Widziałem, jak niektóre projekty używają: parm: ale to nie jest udokumentowane i nie działa. Więc muszą mieć pewne dostosowanie

Mógłbym użyć generic_roles, ale wydaje mi się, że pracuję nad problemem, który z pewnością spotkał innych.

Więc mam nadzieję, że właśnie przeoczyłem coś niesamowicie oczywistego.