Python Sphinx函数调用的自动文档

我希望能够将docstring和/或注释从方法体拉入方法的主docstring中

也就是说，按照

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:

将为_uuuinit中的文档字符串和我的列表生成文档

---

如果sphinx能够以某种方式在“setup\u stuff”和“initialize\u stuff”下添加字符串，那就太好了。这样，您可以在代码中生成自然样式的注释，并让文档从中生成一种伪代码

公共文档（由Sphinx生成）应该记录接口（包、模块、类、方法、参数等），而不是实现（代码、变量等）。只有声明后的第一个字符串被视为docstring，所有其他“docstring”都只是未赋值的值。让用户看到实际代码而不是伪代码如何@Paebbels也许我需要寻找其他文档工具？我的目标是将我的项目移交给下一代开发人员，并使这些文档的数量尽可能接近代码。@mzjn问题是我试图记录一个混乱的代码库。未来的开发人员将关注代码，但是如果代码可以通过收集注释来生成自己的框架，而不是让下一个开发人员倾诉并解析每条语句，那就太好了。还要注意，我试图记录的是一种内部框架，用户可以通过重载和在自己的框架中重新实现部分来开发自己的项目因此，能够清楚地将模块在其init方法中所做的事情与其他developerPublic文档（由Sphinx生成）联系起来是很重要的。Public文档应该记录接口（包、模块、类、方法、参数等等），而不是实现（代码、变量等等）。只有声明后的第一个字符串被视为docstring，所有其他“docstring”都只是未赋值的值。让用户看到实际代码而不是伪代码如何@Paebbels也许我需要寻找其他文档工具？我的目标是将我的项目移交给下一代开发人员，并使这些文档的数量尽可能接近代码。@mzjn问题是我试图记录一个混乱的代码库。未来的开发人员将关注代码，但是如果代码可以通过收集注释来生成自己的框架，而不是让下一个开发人员倾诉并解析每条语句，那就太好了。还要注意，我试图记录的是一种内部框架，用户可以通过重载和在自己的框架中重新实现部分来开发自己的项目因此，能够清楚地将模块在其init方法中所做的事情与其他开发人员联系起来是很重要的