Атрибуты разделения/группировки внутри класса

Question

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

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

Answer 1

Регулярные заголовки разделов REST не работают (см. this fairly recent mailing list thread, а также this older thread), но директива .. rubric:: может использоваться как заголовок в док-строках. Возможно, вы можете использовать что-то вроде этого:

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

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

    .. rubric:: Instance variables 

    :ivar baz: baz documentation 

    """ 

    pass