如何找到所有受支持的python,reStructuredText字段名?

时间:2018-07-18 21:10:43

标签: python restructuredtext

我试图学习的内容比许多python模块中常见的:param myparam: Some description文档样式还多,但是还无法识别出受支持的字段名称的完整列表。从示例中,我收集了paramraisesreturns

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

1 个答案:

答案 0 :(得分:1)

可以找到here:

的字段名称的完整列表
  • 参数,参数,arg,参数,键,关键字:参数说明。
  • 类型:参数的类型。尽可能创建一个链接。
  • 提出,引发例外,但例外: :(在何时)引发特定例外。
  • var,ivar,cvar:变量说明。
  • vartype::变量的类型。尽可能创建一个链接。
  • 返回,返回:返回值的说明。
  • rtype:返回类型。尽可能创建一个链接。