Python Sphinx autodoc复制模块名称和功能名称
我有一个python模块,其结构如下:Python Sphinx autodoc复制模块名称和功能名称,python,python-sphinx,autodoc,Python,Python Sphinx,Autodoc,我有一个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 我
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/\uuuu init\uuuu.py
文件的结构如下:
from .testA import testA
from .testB import testB
from .testC import testC
因此,我的函数现在可以作为
import my_mod.mod1.testA
这与预期的一样。但是,当我使用Sphinx进入autodoc模块时,文档在\uuuu init\uuuu
中遗漏了此功能,最终我的函数被记录为
my_mod.mod1.testA.testA(blah, blah, blah)
这不是实际使用情况,如果在实际脚本中调用,将失败
斯芬克斯有没有办法理解这一点?或者,如果不是一个更好的方法来构造我的模块,以保持我的文件大小小,但在导入时避免重复的名称
感谢您的帮助看起来与@mzjn相似,但提供的链接并不能解决问题。在
mod1/\uuuuu init\uuuuuuuuuuuuuuupy
中创建\uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu。。。automodule::my_mod.mod1
也没有什么区别。设置add\u module\u names=False
会删除所有“文件路径”信息,稍微清理一下文档。。。谢谢你的关注也许这有帮助:。如果没有,请提供一个类似于@mzjn的链接。提供的链接不能解决问题。在mod1/\uuuuu init\uuuuuuuuuuuuuuupy
中创建\uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu。。。automodule::my_mod.mod1
也没有什么区别。设置add\u module\u names=False
会删除所有“文件路径”信息,稍微清理一下文档。。。谢谢你的关注也许这有帮助:。如果没有,请提供一个。