如何查找所有受支持的 python、reStructuredText 字段名？

Question

我正在尝试学习许多 python 模块中常见的常见 :param myparam: Some description 文档样式，但无法确定支持的字段名的完整列表。从示例中，我收集了 param、raises、returns。

def my_method(self, someval):
    """Returns one plus the given value
    :param someval: an integer on which to operate
    :whatelseisthere:
    """
    return someval + 1

http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Answer 1

可以找到完整的字段名称列表here:

• param, parameter, arg, argument, key, keyword: 参数说明。
• type: 参数类型。如果可能，创建一个 link。
• raises, raise, except, exception: 引发（以及何时）特定异常。
• var, ivar, cvar:变量描述。
• vartype: 变量的类型。如果可能，创建一个 link。
• returns, return: return 值的描述。
• rtype: Return类型。如果可能，创建一个 link。