代码示例:
class A(object):
def do_something(self):
""" doc_a """
def inside_function():
""" doc_b """
pass
pass
I tried:
.. autoclass:: A
.. autofunction:: A.do_something.inside_function
但它不起作用。
有什么方法可以生成doc_b
for me?
函数内的函数位于局部变量范围内。函数的局部变量不能从函数外部访问:
>>> def x():
... def y():
... pass
...
>>> x
<function x at 0x7f68560295f0>
>>> x.y
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'function' object has no attribute 'y'
如果 Sphinx 无法获取该函数的引用,则它无法记录该函数。
可能有效的解决方法是将函数分配给函数的变量,如下所示:
>>> def x():
... def _y():
... pass
... x.y = _y
...
一开始将无法访问:
>>> x.y
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'function' object has no attribute 'y'
但第一次调用该函数后,它将是:
>>> x()
>>> x.y
<function _y at 0x1a720c8>
如果 Sphinx 导入模块时执行该函数,这可能会起作用。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)