Sphinx:在自动方法条目之间放置标题

时间:2016-04-03 23:31:56

标签: python-sphinx

我正在使用Sphinx来记录一个有很多方法的类。我想把这些方法分成几个部分,用标题分隔,如下所示:

.. autoclass:: MyClass

   .. automethod:: __init__

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

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

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

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

但这似乎不起作用。是否有可能以某种方式将方法列表分解为命名的部分?

1 个答案:

答案 0 :(得分:1)

带有标题的部分是顶级结构,不能在指令内部使用。但rubric有效。例如:

.. autoclass:: MyClass

   .. automethod:: __init__

   .. rubric:: FooBar Methods

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