如何使用sphinx避免重复的函数文档?

时间:2017-04-10 09:03:32

标签: python python-sphinx

假设我有以下结构

mypackage
    __init__.py
    core.py

使用__init__.py

from .core import my_function

__all__ = ['my_function']

core.py

def myfunction():
    ''' really cool function '''
    pass

正在运行sphinx-apidoc --full -o docspython setup.py build_sphinx 我得到了myfunction两次的文档。

如何避免这种重复,最好只将文档放在顶层(因为这是用户的API)。

0 个答案:

没有答案