python - 如何在 Sphinx 的 Python 文档字符串中指定变量类型？

Question

您可以像这样在 Python 文档字符串中指定参数类型:

def __init__(self, canvas, segments):
    """Class constructor.

    :param canvas: the PDF canvas object
    :param segment: The layer segments to be drawn.

    :type canvas: `canvas.Canvas`
    :type segments: list of str
    """
    ...

借助 Sphinx 的自动文档功能，这会生成参数列表，并且每个参数都正确标记了它们的类型。

但是我如何使用实例属性来做到这一点呢？像这样

class Path(object):
    """
    :ivar edge_indices: The indices within `textured_points` of the places.

    :type edge_indices: list of int
    """

不起作用。可以在 :ivar 之后放置一个单词 类型，但在这里，它由三个词组成，所以这是行不通的。

Answer 1

我遇到了同样的问题。答案是vartype:

class Foo:
    """
    :ivar edge_indices: description
    :vartype edge_indices: list of int
    """