Python sphinx中方法组的Docstring
是否可以在Sphinx生成的文档中为方法组添加docstring 例如,我想要一些类似于:Python sphinx中方法组的Docstring,python,python-sphinx,Python,Python Sphinx,是否可以在Sphinx生成的文档中为方法组添加docstring 例如,我想要一些类似于: 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_fr
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
请注意,我的目标不是(仅)对方法进行分组(如中所示),而是向组中添加docstring。docstring是作为模块、函数、类或方法定义()中的第一条语句出现的字符串文字。您不能有像问题中那样的“额外”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
有谁能解释下一票,以便我改进我的问题吗?docstring是作为模块、函数、类或方法定义中的第一条语句出现的字符串文字。看见您不能像示例中那样拥有“额外”的docstring。我明白了。所以对于分组方法没有任何解决方案?这个解决方案对我来说是一个很好的折衷方案:因为我需要自己组织方法,它们的文档不能完全自动(听起来很明显…)。