Class docstring块中的class属性docstring

Question

我正在使用Sphinx记录我的Python项目，并希望在class docstring块中记录class属性。属性内联文档字符串很难看。

我确实尝试将docstring属性添加到类docstring块中，但当Sphinx生成html时，它不能正确显示。

class MyClass():
    """
        MyClass docstring block.

        Attributes:
            name - A single attribute.
            :attr name - A single attribute.
    """

    name = "ABC"

生成的html显示一条简单的行。取而代之的是使用属性内联docstring来显示一个很好的样式。

Attribute inline docstring

Attribute docstring in class block docstring

Answer 1

您应该在属性名称后面加一个冒号：

class MyClass():
    """MyClass docstring block.

        Attributes:
            name: A single attribute.
            name: A single attribute.
    """

    name = "ABC"