Sphinx: Platzieren Sie die Überschrift zwischen Automethod-Einträgen

Question

Ich benutze Sphinx, um eine Klasse mit vielen Methoden zu dokumentieren. Ich würde zu einer Gruppe wie die Methoden in einzelne Abschnitte, getrennt durch Header, wie folgt aus:

.. autoclass:: MyClass 

    .. automethod:: __init__ 

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

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

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

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

Aber das scheint nicht zu funktionieren. Ist es möglich, die Methodenliste in bestimmte Abschnitte zu zerlegen?

Answer 1

Abschnitte mit Überschriften sind Konstrukte der obersten Ebene und können nicht innerhalb von Anweisungen verwendet werden. Aber rubric funktioniert. Beispiel:

.. autoclass:: MyClass 

    .. automethod:: __init__ 

    .. rubric:: FooBar Methods 

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