docstring

时间:2017-10-05 22:08:24

标签: python python-sphinx restructuredtext

在记录代码时,我喜欢输入输入和输出的类型。目前,我将文档字符串中的方法输入列为:

:param some_input: The method input.
:type some_input: str

编译很好:

参数:some_input(str) - 方法输入。

在上文中,'str'实际上自动链接到https://docs.python.org/2/library/functions.html#str。我希望我的回报也有同样的东西,列出的类型,并希望链接到类的文档。按照狮身人面像网站上的标记:http://www.sphinx-doc.org/en/stable/domains.html,我尝试过:

:return: The methods output.
:rtype: int

但是这会编译为:

返回:方法输出。

返回类型: int

而不是在一行上列出返回名称和类型。有没有一种很好的方法来获得与param相同的结果?

Sphinx是v1.6.4,主题是雪花石膏

0 个答案:

没有答案