引用Python文档字符串中的参数

Question

我使用Sphinx和autodocs功能来确保我们的项目中有很好的文档.

所以我熟悉信息字段列表,我熟悉在我们的文档中使用交叉引用.

但是,在为方法或函数编写docstring时,我发现在文本中引用它们的参数很有用.但似乎没有一种结构化的方式来做到这一点.

1. 我们可以说例如

   Use ``name`` to set the username
   

   但是没有结构,要求你记住你用过的样式,如果你改变了样式,你必须追捕并杀死所有不正确的样式.

2. :param:在信息字段列表之外不起作用,所以你不能写

   Use :param:`name` to set the username
   

3. 我已经看到一些项目使用:parm:但是没有记录,似乎没有用.所以他们必须有一些定制

4. 我可以使用generic_roles,但这似乎是我解决了一个我确信其他人遇到过的问题.

所以我希望我错过了一些令人眼花缭乱的事情.

Answer 1

您可以使用autodoc-process-docstring编写自己的扩展- 这非常简单。

让扩展程序搜索:param:并将其替换为您选择的样式。