Sphinx函数调用autodocumentation

Question

我希望能够将方法正文中的文档字符串和/或注释拖到方法的主文档字符串中。

这就是说

的内容

class MyClass(object):
  def __init__(self):
     """This is a summary of the initialization which does the following:
     """

     my_list = []
     """ a list to hold things """

     self.setup_stuff()
     """ sets up stuff"""

     self.initialize_stuff()
     """ initializes stuff"""

我知道

.. autoclass:: MyClass
   :members:

将生成来自__ init __和my_list的文档字符串的文档。

如果sphinx以某种方式将字符串附加在'setup_stuff'和'initialize_stuff'下，那将是很好的。这样你就可以在你的代码中制作自然风格的注释，并让文档从中产生一种伪代码。