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

Question

我正在寻找一种方法来生成文档，pydoc在这种情况下，嵌套函数。这可能与pydoc？其他工具可以吗？

例如：

""" 
Module docstring. 
""" 

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

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

生成具有是pydoc：是pydoc -w -filename-将生成的模块和Foo（）是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 
     """ 
     ... 

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