如何使Sphinx autodoc文档成为对象属性的函数?

时间:2014-03-31 20:58:30

标签: python python-sphinx autodoc

我有一个模块,我在其中创建了一个函数chain(类似于itertools.chain),所以我想我会模仿itertools接口并公开{{ 1}}功能也是。为此,我只需定义另一个函数,然后将其封装到chain.from_iterable上,如下所示:

chain

以及chain = _create_chain(environment) 中的某个地方:

_create_chain

_chain.from_iterable = _from_iterable return _chain chain都有文档字符串,一切正常,但我想用Sphinx自动记录chain.from_iterablechain。现在我有

chain.from_iterable

并为.. automodule:: mymodule :members: .. autofunction:: chain 创建文档,但为chain添加另一个autofunction指令会产生chain.from_iterable,因为它认为ImportError是一个模块:< / p>

chain

如何在此方案中包含WARNING: autodoc: failed to import function u'from_iterable' from module u'chain'; the following exception was raised: Traceback (most recent call last): File "/usr/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 335, in import_object __import__(self.modname) ImportError: No module named chain 的文档?

0 个答案:

没有答案