Как указать тип переменных в строках документации Python для Sphinx?

Вы можете указать типы параметров в строках документации 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
    """
    ...

С помощью функции Autodoc Sphinx это дает список параметров, и каждый параметр правильно помечен своим типом.

Но как мне сделать это с атрибутами экземпляра? Что-то вроде этого

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

    :type edge_indices: list of int
    """

не работает. Можно поместить тип однословный после :ivar, но здесь он состоит из трех слов, так что это не сработает.


python python-sphinx autodoc docstring
person Torsten Bronger    schedule 16.12.2014    source источник

Ответы (1)


arrow_upward
6
arrow_downward

У меня была такая же проблема. Ответ vartype:

class Foo:
    """
    :ivar edge_indices: description
    :vartype edge_indices: list of int
    """
person Tim    schedule 26.01.2017