私は関数を作成するモジュールを持っているのでchain
(のように振る舞う)、インターフェイスを模倣して関数も公開itertools.chain
しようと思いました。そのためには、別の関数を定義して、次のように貼り付けます。itertools
chain.from_iterable
chain
chain = _create_chain(environment)
そしてどこか_create_chain
:
_chain.from_iterable = _from_iterable
return _chain
との両方chain
にdocstrings があり、すべて正常に動作しますが、Sphinx でと の両方を自動的chain.from_iterable
にドキュメント化したいと考えています。今、私は持っていますchain
chain.from_iterable
.. automodule:: mymodule
:members:
.. autofunction:: chain
のドキュメントを作成しますが、別のディレクティブをchain
追加すると、モジュールと見なされるため、結果は になります。autofunction
chain.from_iterable
ImportError
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
chain.from_iterable
このシナリオにドキュメントを含めるにはどうすればよいですか?