reStructuredTextのリンクが

Question

は

：

def _add_parameter(self, a): 
    # do something 

を私はreStructuredTextのを使用して上記の機能にリンクするドキュメント文字列を追加したい、私はただの末尾にアンダースコアを追加する必要があります次のような関数名：

""" 
The _add_parameter_ adds parameters. 
""" 

しかし、その代わりの機能にリンクは、私がcannot find declaration to go to警告が表示されます。これをどうやって解決するのですか？

Answer 1

autodoc拡張機能では、プライベートメンバー以外のメンバー、つまり名前がアンダースコアで始まらないメンバーのみが文書化されます。マニュアルから：

.. autoclass:: Noodle 
     :members: 
    will document all non-private member functions and properties (that is, 
    those whose name doesn’t start with _). 

したがって、オートドックがリンク先を見つけようとすると、それは見つからない。

プライベートメンバーを文書化しないでオーバーライドするには、:private-members:を使用できますが、それが機能するかどうかは私には分かりません。しかし、一般的にはパブリックインターフェイスのみを文書化することをお勧めします。