我有一个具有以下结构的python模块:
my_mod
|--- __init__.py
|--- mod1
| |---- __init__.py
|---- testA.py
|---- testB.py
|---- testC.py
每个testX.py内都有一个名为testX 的函数。这些功能很大,因此为了使文件易于管理,我将testA,B和C分开了。为了避免以这种方式访问这些功能:
import my_mod.mod1.testA.testA
我的mod1/__init__.py
文件的结构如下:
from .testA import testA
from .testB import testB
from .testC import testC
所以我的功能现在可以通过
访问import my_mod.mod1.testA
此行为符合预期。但是,当我使用Sphinx对模块进行自动文档处理时,文档在__init__
中缺少此功能,最终我的函数被记录为
my_mod.mod1.testA.testA(blah, blah, blah)
这不是实际用法,如果在实际脚本中调用将失败。
Sphinx是否有办法理解这一点?或者,如果不是更好的方法来构造模块以保持文件较小,但避免在导入时重复名称呢?
感谢您的帮助