python - 如何使用 sphinx-apidoc 记录 Python 函数参数？

Question

我正在尝试清理我的 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
   """

Answer 1

通常“函数变量”称为参数；)。

记录在此处:http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#signatures

答案是:param ________

编辑 免责声明:我从未使用过或听说过 sphinx...这篇文章主要是“搜索什么词”。希望对您有所帮助。