Строка документации атрибута класса внутри блока строки документа

Question

Я документирую свой проект Python с помощью Sphinx и хочу документировать атрибуты класса внутри блока класса docstring.Встроенные строки документации атрибута ужасны.

Я пытался добавить строку документации атрибута в блок строки класса, но когда Sphinx создает HTML, он не отображается должным образом.

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

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

    name = "ABC"

Сгенерированный HTML отображает простую строку,Вместо этого с атрибутом inline docstring отобразите хороший стиль.

Атрибут inline docstring

Атрибут docstring в блоке строк класса

Answer 1

Вы должны поставить двоеточие после имени атрибута:

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

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

    name = "ABC"