2016-04-03 2 views
1

Я использую Sphinx для документирования класса с большим количеством методов. Я хотел бы, чтобы сгруппировать методы в секциях, разделенных заголовками, как это:Sphinx: помещайте заголовок между записями automethod

.. 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 
Смежные вопросы