napoleon_use_ivar
オプションを に設定してGoogle docstrings(numpyはテストしていませんが、同様の問題があると思われます)でナポレオンを使用すると、インスタンス変数の名前True
へのリンクが作成されます。これらの名前は明らかに非常に一般的であり (「名前」など)、ランダムな定義にリンクすることは役に立ちません。これを無効にする方法はありますか?
次のドキュメント文字列が与えられた場合:
"""
Attributes:
name (str): Friendly name
"""
name
html 出力で相互参照を試みます。ターゲットのあいまいさを考えると、これについて不平を言います。
/home/nbastin/geni-lib/geni/rspec/pgad.py:docstring of geni.rspec.pgad.AdInterface:None: WARNING: more than one target found for cross-reference u'name': geni.rspec.igext.AddressPool.name, geni.rspec.vtsmanifest.GREPort.name, geni.rspec.vtsmanifest.InternalPort.name, geni.rspec.pg.
Node.name, geni.rspec.vtsmanifest.PGLocalPort.name, geni.rspec.pg.Interface.name, geni.rspec.vtsmanifest.GenericPort.name, geni.rspec.vtsmanifest.ManifestContainer.name, geni.urn.GENI.name, geni.rspec.vtsmanifest.InternalContainerPort.name
ただし、それでも HTML 出力にリンクが作成されます。属性をクリックするname
と、現在の属性とは関係のないランダムなシンボルに喜んで送信されます。この動作を無効にする方法はありますか?
napoleon_use_ivar
がこれに設定されている場合はFalse
発生しませんが、属性の出力はまったくコンパクトではなく、非常に読みにくいものです。
これはNapoleon 固有のものではありませんivar
。手動で属性を指定すると、制御できない方法で相互参照されます。
:ivar name: Friendly name
:vartype name: str
それはまだ へのリンクを取得しname
ます。