Sphinx：パラメータと同じ属性を文書化してください。

Question

numpyスタイルのdocstringでこれをドキュメントしたいと思います。

​​

属性とパラメーターは同じです。繰り返すことはできませんか？

Answer 1

入力パラメータと属性がまったく同じ参照の場合は、その属性のみを文書化します。 Pythonに精通している人なら、そのパラメータがすぐにわかるはずです。

さらに複雑な場合は、クラス自体と__init__メソッドの両方を文書化することをお勧めします。この場合、パラメータの説明は__init__のdocstringに入ります。

autodoc拡張子を使用しているように見えるので、autoclassディレクティブに:special-members: __init__オプションを追加する必要があります。他の特別会員を文書化する場合は、オプションのパラメータリストに追加することができます。 :special-members:の引数をすべて省略して、すべての魔法の属性を文書化することもできますが、望ましくないものが含まれている可能性があります（__weakref__など）。