python - sphinx 中方法组的文档字符串

Question

是否可以在 Sphinx 生成的文档中为方法组添加文档字符串？

例如，我想要这样的东西:

class MyClass():
    """Doc of the class"""
    def __init__(self):
        pass

    """----- The following part is about imports -----"""

    def import_from_source_1(self):
        """Doc of import_from_source_1"""
        pass

    def import_from_source_2(self):
        """Doc of import_from_source_2"""
        pass

    """----- The following part is about exports-----"""

    def export_to_dest_1(self):
        """Doc of export_to_dest_1"""
        pass

    def export_to_dest_2(self):
        """Doc of export_to_dest_2"""
        pass

预期输出为:

MyClass
    Doc of the class

----- The following part is about imports -----
import_from_source_1
    Doc of import_from_source_1

import_from_source_2
    Doc of import_from_source_2

----- The following part is about exports-----
export_to_dest_1
    Doc of export_to_dest_1

export_to_dest_2
    Doc of export_to_dest_2

请注意，我的目标不是(仅)对方法进行分组(如 Group method docstrings in sphinx 中所示)，而是向组中添加文档字符串。

Answer 1

文档字符串是一个字符串文字，作为模块、函数、类或方法定义中的第一个语句出现 ( https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring )。您不能拥有像问题中那样的“额外”文档字符串。

但是，您可以使用automethod进行分组:

.. currentmodule:: mymodule

.. autoclass:: MyClass
   
   The following part is about imports
 
   .. automethod:: import_from_source_1
   .. automethod:: import_from_source_2
 
   The following part is about exports
 
   .. automethod:: export_to_dest_1
   .. automethod:: export_to_dest_2