Python sphinx Sphinx,使用自动模块查找子模块
使用sphinx的automodule()时 我只需在.rst文件中写入:Python sphinx Sphinx,使用自动模块查找子模块,python-sphinx,Python Sphinx,使用sphinx的automodule()时 我只需在.rst文件中写入: .. automodule:: my_module :members: 它很好地记录了my_模块,但没有找到像my_模块.inner_模块0和my_模块.inner_模块1这样的内部模块。除了_all _变量外,_init__;.py文件中是否还需要指定一些内容 另外,我知道斯芬克斯apidoc。但是该命令文档太多(公开了每个函数/文件夹,包括未记录的函数/文件夹)。听起来您想给automodule指令一个包名
.. automodule:: my_module
:members:
它很好地记录了my_模块,但没有找到像my_模块.inner_模块0和my_模块.inner_模块1这样的内部模块。除了_all _变量外,_init__;.py文件中是否还需要指定一些内容
另外,我知道斯芬克斯apidoc。但是该命令文档太多(公开了每个函数/文件夹,包括未记录的函数/文件夹)。听起来您想给
automodule
指令一个包名,让它递归到目录中,并记录每个Python模块。这还不受支持。您需要为要记录的每个模块指定完整的虚线模块名称
例如,给定以下目录结构(来自Python文档)。不能指定。。automodule::sound.formats
,并让它记录目录中的所有模块。您必须为每个模块指定一个automodule
命令:。。automodule::sound.formats.waveread
,。。automodule::sound.formats.wavewrite等
sound/ Top-level package
__init__.py Initialize the sound package
formats/ Subpackage for file format conversions
__init__.py
wavread.py
wavwrite.py
aiffread.py
aiffwrite.py
auread.py
auwrite.py
...
effects/ Subpackage for sound effects
__init__.py
echo.py
surround.py
reverse.py
...
在我看来,(非直接链接,确实使用搜索)现在应该是可能的,如果\uuuu init\uuuuu.py
导入这些子模块
然而,我个人还不能做到这一点
编辑:可能是一个。我不认为使用导入的成员可以解决这个问题。伊姆霍,@devin_的高票答案是正确的(或者至少在正确的轨道上)。自2013年8月以来,询问者在堆栈溢出问题上一直不活跃,因此我们似乎不太可能从他那里得到确认。没错。。。重读这个问题,似乎我误解了它,通过我自己任务的视角来解释。抱歉吵闹了。这是一个很老的答案了。还是没有自动发现的情况吗?@NOTT101请参见sphinx apidoc
和sphinx autogen
@NOTT101这可能特别有趣。