类docstring块内的类属性docstring

Question

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

我确实尝试将属性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"