Sphinxとautodocs機能を使用して、プロジェクトに適切なドキュメントがあることを確認します。
したがって、私は情報フィールドリストに精通しており、ドキュメントでの相互参照の使用にも精通しています。
ただし、メソッドまたは関数のdocstringを作成するときは、テキストでそれらのパラメーターを参照すると便利です。しかし、これを行うための構造化された方法はないようです。
私たちは例えば言うことができます
Use ``name`` to set the username
しかし、これには構造がなく、そのために使用したスタイルを覚えておく必要があります。スタイルを変更した場合は、間違ったスタイルをすべて探して殺す必要があります。
:param:情報フィールドリストの外では機能しないため、書くことはできません
Use :param:`name` to set the username
いくつかのプロジェクトが:parm:を使用しているのを見てきましたが、それは文書化されておらず、機能していないようです。だから彼らはいくつかのカスタマイズが必要です
- generic_rolesを使用することもできますが、他の人が遭遇したと確信している問題を回避しているようです。
だからうまくいけば、私は盲目的に明白な何かを見逃しただけです。