我正在寻找一种方法来生成文档,在这种情况下为pydoc,用于嵌套函数.这可能与pydoc一起使用吗？是否可以使用其他工具？

例如：

"""
Module docstring.
"""

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

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

使用：pydoc -w -filename-生成pydoc将为模块和foo()生成pydoc,但不为bar()生成pydoc.

通常这没关系;问题是我正在尝试为教育目的构建一个库,并记录闭包内部发生的事情是特别有用的.我想找到一种方法来记录它,而不必将内部函数暴露给全局范围.

解决方法:

总有手动方法：

"""
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
        """
        ...

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