Секционирование / группирование атрибутов внутри класса

Question

У меня есть класс с большим количеством атрибутов; Я хотел бы представить их сгруппированными (а не в виде плоского списка) с видом, похожим на раздел, внутри документации класса.

Это возможно с documenttils/sphinx? Любое предложение для достижения чего-то визуально похожего, возможно, путем добавления фиктивных атрибутов?

Answer 1

Обычные заголовки разделов reST не работают (см. Эту довольно недавнюю ветку списка рассылки, а также эту старую ветку), но .. rubric:: Директива может использоваться в качестве заголовка в строках документации. Возможно, вы можете использовать что-то вроде этого:

class MyClass(object):
    """
    .. rubric:: Class variables 

    :cvar foo: foo documentation
    :cvar bar: bar documentation

    .. rubric:: Instance variables

    :ivar baz: baz documentation

    """

    pass