为什么pydoc中没有显示类中某些方法的docstrings？

Question

我正在使用pydoc来创建文档。 但它只显示类docstring和__init__等方法。是否有任何参数传递给pydoc以创建类的每个方法的文档？

示例：

class myclass(some_other_class):
    """
    This is 'class' docstring.
    """

    def __init__(self):
       """
       This is docsctring for __init__ method.
       """
       pass

    def mymethod(self, some_parameter):
       """
       This is docstring for mymethod function.
       """
       pass

现在当我在这段代码上使用pydoc时，我没有看到＆＃34;这是mymethod函数的docstring。＆＃34;在输出中生成。

Answer 1

您的代码看起来非常好，我将其放在 script.py 文件中，删除了“some_other_class”引用，然后运行python -m pydoc -w script。它生成了以下HTML：

class myclass
      This is 'class' docstring.

      Methods defined here:
          __init__(self)
            This is docsctring for __init__ method.
          mymethod(self, some_parameter)
            This is docstring for mymethod function.