在Python文档字符串引用参数(Referencing parameters in a Pytho

我使用的狮身人面像和autodocs功能，以确保我们在我们的项目中很好的文档。

所以我很熟悉的信息字段列表 ，我很熟悉使用交叉引用在我们的文档。

不过，编写文档字符串的方法或函数时，我发现它有用参考它们的参数中的文本。 但似乎没有要做到这一点结构化的方式。

1. 我们可以说，如

    Use ``name`` to set the username 

   但没有结构，需要你记住你用什么样的风格为，如果你改变风格，你必须追捕和杀死所有不正确的样式。

2. ：PARAM：不工作的信息字段列表之外的，所以你不能写

    Use :param:`name` to set the username 

3. 我见过一些项目使用：PARM：但是一个没有文档似乎并没有工作。 因此，他们必须有一些定制

4. 我可以用generic_roles但好像我的周围，我敢肯定其他人遇到问题的工作。

所以希望我只是错过了一些东西言自明。

Answer 1:

您可以通过编写自己的分机车博士-过程-文档字符串 -它真的很简单。

有扩展搜索:param:与您所选择的风格取代它。

文章来源: Referencing parameters in a Python docstring