次のように、Python docstring でパラメーターのタイプを指定できます。
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 の autodoc 機能を使用すると、これによりパラメーター リストが生成され、各パラメーターにはその型が適切にタグ付けされます。
しかし、インスタンス属性でこれを行うにはどうすればよいでしょうか? このようなもの
class Path(object):
"""
:ivar edge_indices: The indices within `textured_points` of the places.
:type edge_indices: list of int
"""
動作しません。の後に1 語の型を置くこともできます:ivar
が、ここでは 3 つの単語で構成されているため、機能しません。