Ich benutze Sphinx und die Autodocs-Funktion, um sicherzustellen, dass wir gute Dokumente in unserem Projekt haben.

Also bin ich vertraut mitInfofeldlisten und ich bin vertraut mit der VerwendungQuerverweise in unseren Dokumenten.

Wenn ich jedoch Docstring für eine Methode oder Funktion schreibe, finde ich es nützlich, auf deren Parameter im Text zu verweisen. Aber es scheint keinen strukturierten Weg dafür zu geben.

Wir könnten z.B.

Use ``name`` to set the username

Aber das hat keine Struktur. Sie müssen sich merken, welchen Stil Sie dafür verwendet haben. Wenn Sie den Stil ändern, müssen Sie alle falschen Stile suchen und töten.

: param: funktioniert nicht außerhalb einer Infofeldliste, Sie können also nicht schreiben

Use :param:`name` to set the username

Ich habe einige Projekte verwenden: Parm: aber das ist nicht dokumentiert und scheint nicht zu funktionieren. Sie müssen also angepasst werden

Ich könnte generic_roles verwenden, aber das scheint, als würde ich ein Problem umgehen, auf das andere sicher gestoßen sind.

Hoffentlich habe ich etwas verpasst, das so offensichtlich ist.