有没有办法为嵌套函数生成pydoc？

Question

我正在寻找一种方法来为嵌套函数生成文档，在这种情况下是pydoc。使用pydoc可以做到这一点吗？是否可以使用其他工具？

例如：

"""
Module docstring.
"""

def foo(x):
    """
    Foo does something.
    """
    ...

    def bar(y):
        """
        Bar does something
        """
        ...

使用以下命令生成pydoc : pydoc -w -filename-将为模块和foo()生成pydoc，但不会为bar()生成pydoc。

通常这是可以的；问题是我正在尝试构建一个用于教育目的的库，记录闭包中发生的事情是特别有帮助的。我希望找到一种方法来记录它，而不必将内部函数公开给全局作用域。

Answer 1

总是有手动的方法：

"""
Module docstring.
"""

def foo(x):
    """
    Foo does something.
    N.B. Foo includes a local function bar() that does what bar does.
    """
    ...

    def bar(y):
        """
        Bar does something
        """
        ...

它不是自动的，但它确实意味着您的学生只能看到您希望他们看到的那些私有方法的文档。