在类中划分/分组属性

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