2013-06-26 45 views
1

我有一個具有大量屬性的類;我想將它們分組(而不是列入單元列表),並在類文檔中使用類似部分的外觀。在一個類中劃分/分組屬性

這對docutils/sphinx可能嗎?任何建議可能通過插入虛擬屬性來實現視覺上相似的東西?

回答

1

規律作息部分的標題不工作(見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 
+0

非常有用和簡單的解決方法。你提到的第一個線程有一些相當簡單的補丁來將這個功能添加到獅身人面像,希望它能在某個時候被上游獲得。 – eudoxos