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

我正试图整理我的python代码文档，并决定使用它，因为它看起来不错。我喜欢用标签引用其他类和方法，如：

: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
   """

通常，“函数变量”称为参数；）

这里有记录：

答案是

：param\uuuuuuuuuuuuuuuuuuuuuuuuu

---

编辑免责声明：我从未使用或听说过斯芬克斯。。。这篇文章主要是一篇“搜索什么词”。希望能有所帮助。

添加此答案以整合选项：

是基本的，没有特殊的格式

使用格式“@param var:”

面向更广泛的语言

---

使用格式“：param type var:”。另见。这是用来创建的

谢谢。。。我找错东西了。我曾尝试过param，但不断出现错误，没有意识到语法不是：param:

variable1

，而是：param variable1:和用于记录复杂参数（列表、dicts等）的约定。-@Crisfole，我认为您答案中的链接没有指向正确的页面。这些被称为“信息字段列表”。另请参见Sphinx的扩展，它允许在其中任何一个中使用文档字符串，这两个字符串看起来都比普通的Sphinx好。还有一个有趣的地方：