代码之家 › 专栏 › 技术社区 › tarabyte

如何查找所有支持的python、restructuredtext字段名?

restructuredtext python

tarabyte · 技术社区 · 6 年前

我想学的不仅仅是普通人 :param myparam: Some description 许多python模块中常见的文档样式,但还不能识别支持的字段名的完整列表。从例子中,我收集到 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

1 回复 | 直到 6 年前

mooglinux 6 年前

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

参数,参数,参数,参数,键,关键字: 参数的描述。
类型: 参数的类型。如果可能,创建链接。
引发,引发,异常: 引发了一个特定的异常。
var、ivar、cvar: 变量的描述。
变量类型: 变量的类型。如果可能,创建链接。
返回,返回: 返回值的描述。
rtype: 返回类型。如果可能,创建链接。

推荐文章

AZhao · 放入图像的语法。rst公司

7 年前

bluprince13 · 如何使用重组文本嵌入完整PDF?

7 年前

guettli · 如何确保自述。rst有效吗?

7 年前

Jared Wilber · 渲染内部标记文件的输出。rst文件

7 年前

Mad Physicist · 如何通过sphinx链接到Python 3文档中的typecontextmanager标签

7 年前

Ray Brian Agnew · Python ReST文档字符串中是否有类似C#'s“see cref”的内容?

7 年前

paugier · Math Latex宏用于在reStructuredText和Sphinx中进行替换

10 年前

mgilson · ..重新构造文本中的绘图指令

11 年前