有没有办法为嵌套函数生成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
        """
        ...

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