引用Python文档字符串中的参数 [英] Referencing parameters in a Python docstring

问题描述

我使用Sphinx和Autodocs功能来确保我们的项目中有好的文档。

所以我熟悉info field lists，也熟悉在我们的文档中使用cross-referencing。

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

1. 我们可以说

   Use ``name`` to set the username
   

   但这没有结构，要求您记住您为此使用的样式，如果您更改样式，则必须查找并删除所有不正确的样式。

2. ：param：在信息字段列表之外不起作用，因此您无法写入

   Use :param:`name` to set the username
   

3. 我见过一些项目使用：Parm：但这没有文档记录，似乎也不起作用。因此他们必须进行一些定制

4. 我可以使用GENERIC_ROLES，但这似乎是我要解决的问题，我相信其他人也会遇到这个问题。

所以希望我刚刚错过了一些非常明显的东西。

推荐答案

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

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

这篇关于引用Python文档字符串中的参数的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！