我喜欢使用Sphinx从文档字符串创建python模块代码文档。当我使用带有.members选项的.. automodule ::指令创建文档时,生成的文档包含类中每个方法的文档字符串,但是我缺少类方法中的方法文档。>
我尝试使用.. automodule ::指令,并且尝试了.. automodapi ::指令。它们都不包含模块中类方法中的文档字符串。
class analyzer():
""" docstring for the analyzer class """
print("I'm a class")
def class_method():
""" docstring of the class method """
print("I'm a class method")
def class_methods_method():
""" docstring of the class methods method """
print("I'm a class methods method")
我想将class_methods_method及其文档字符串包含在Sphinx创建的文档中。当我使用以下指令创建文档时:
.. automodule:: analyzer
:members:
文档包括类docstring和class_methods docstring。缺少class_methods_method文档字符串。
是否有办法使它正常工作?