2016-04-03 5 views
1

私は多くの方法でクラスを文書化するためにSphinxを使用しています。私はこの方法をヘッダのように区切られたセクションにまとめたいと思います。Sphinx:自動投稿エントリの間に見出しを置く

.. autoclass:: MyClass 

    .. automethod:: __init__ 

    FooBar Methods 
    -------------- 

    .. automethod:: foo 
    .. automethod:: bar 

    BazQux Methods 
    -------------- 

    .. automethod:: baz 
    .. automethod:: qux 

しかし、それはうまくいかないようです。何とかメソッドリストを名前付きセクションに分割できますか?

答えて

1

見出しのあるセクションはトップレベルの構造であり、ディレクティブ内では使用できません。しかし、rubricが動作します。例:

.. autoclass:: MyClass 

    .. automethod:: __init__ 

    .. rubric:: FooBar Methods 

    .. automethod:: foo 
    .. automethod:: bar 
関連する問題