Napoleon numpy スタイルで文書化されたいくつかの関数を含むプロジェクトがあります。numpyness の精神で、 class の関数引数がたくさんありますarray-like。次に例を示します。
def foo(x, y):
"""
Foo the arguments together to make a bar.
Parameters
----------
x : array-like
This is an argument.
y : array-like
I like it, give me another!
Returns
-------
bar : numpy.ndarray
Works every time
"""
pass
これは問題なく機能し、タイプはリンクなしで出力に含まれます。
問題は、これを持つすべての関数のすべての行で警告が表示されることです:
/.../my_project/my_module.py:docstring of my_project.my_module.foo:: WARNING: py:class reference target not found: array-like
/.../my_project/my_module.py:docstring of my_project.my_module.foo:: WARNING: py:class reference target not found: array-like
何らかの解決策があると私はかなり確信しています。PR #7690が何らかの形でこれに対処したようですが、ナポレオンまたはより広範なスフィンクスのドキュメントのどこにも意味のある参照「前処理」が見つかりません。
では、どうすれば警告を取り除くことができますか?