Python関数パラメーターをsphinx-apidocで文書化する方法は？
pythonコードドキュメントをクリーンアップしようとしていますが、見た目が良いので sphinx-doc を使用することにしました。他のクラスやメソッドを参照する方法が好きです。次のようなタグを使用：
:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function
関数内のパラメーター名を文書化する方法を理解しようとしているので、次のような関数がある場合は次のようになります。
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something?:`parameter1` And then describe the parameter.
"""
これのベストプラクティスは何ですか？
更新：
正しい構文は次のとおりです。
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something parameter1: And then describe the variable
"""
通常、「関数変数」はパラメータと呼ばれます;）。
ここに文書化されています： http://sphinx.pocoo.org/domains.html#signatures
そして答えは:param ________
[〜＃〜] edit [〜＃〜]免責事項：私はスフィンクスを使用したことも聞いたこともありません...検索する単語。」お役に立てば幸いです。